jgtml

🐊 Unified Alligator CLI ✨ NEW ✨

usage: python -m jgtml.alligator_cli [-h] -i INSTRUMENT -t TIMEFRAME -d {S,B}
                                      [--type {regular,big,tide,all}] [--fresh]
                                      [--no-fresh] [--regenerate-cds]
                                      [--no-regenerate-cds] [--mfi] [--no-mfi]
                                      [-q] [--output-dir OUTPUT_DIR]
                                      [--output-basename OUTPUT_BASENAME]
                                      [--generate-spec] [--data-dir DATA_DIR]
                                      [--force-regenerate-mx]

Unified JGTML Alligator Analysis CLI - Multi-timeframe convergence analysis

Required Arguments:
  -i INSTRUMENT, --instrument INSTRUMENT
                        Trading instrument (e.g., SPX500, EUR/USD)
  -t TIMEFRAME, --timeframe TIMEFRAME
                        Analysis timeframe (e.g., D1, H4, H1)
  -d {S,B}, --direction {S,B}
                        Signal direction: S (Sell) or B (Buy)

Alligator Configuration:
  --type {regular,big,tide,all}
                        Alligator analysis type (default: all)
                        • regular: 5-8-13 periods (quick direction detection)
                        • big: 34-55-89 periods (intermediate cycles)  
                        • tide: 144-233-377 periods (macro trends)
                        • all: Multi-Alligator convergence analysis

Data Processing Options:
  --fresh               Use fresh data (regenerate if needed) [default]
  --no-fresh            Use cached data (do not regenerate)
  --regenerate-cds      Force regeneration of CDS data [default]
  --no-regenerate-cds   Use existing CDS data
  --mfi                 Enable Market Facilitation Index analysis [default]
  --no-mfi              Disable MFI analysis

Output Options:
  -q, --quiet           Suppress output (only show errors)
  --output-dir OUTPUT_DIR
                        Custom output directory (default: $jgtdroot/drop)
  --output-basename OUTPUT_BASENAME
                        Custom output filename base
  --generate-spec       Generate .jgtml-spec file from analysis results
  --data-dir DATA_DIR   Override data directory (default: $JGTPY_DATA_FULL)

Advanced Options:
  --force-regenerate-mx Force regeneration of MX files [default]

Features:
• 🔄 Graceful Pattern Handling: Automatically skips unavailable TTF patterns (zonesq)
• 🎯 Intent-Driven Analysis: Generates .jgtml-spec files for agentic integration  
• 🌐 Self-Contained: No external bash script dependencies
• ⚡ Multi-Type Convergence: Analyze all three Alligator types simultaneously
• 🔧 Legacy Compatible: Seamless integration with existing jgtapp tide workflows

Examples:
  # Single Alligator Analysis
  python -m jgtml.alligator_cli -i SPX500 -t D1 -d S --type tide
  
  # Multi-Alligator Convergence (recommended)
  python -m jgtml.alligator_cli -i EUR/USD -t H4 -d B --type all
  
  # Generate .jgtml-spec for agentic workflows
  python -m jgtml.alligator_cli -i GBPUSD -t D1 -d S --type all --generate-spec
  
  # Quiet mode with custom output
  python -m jgtml.alligator_cli -i EURUSD -t H1 -d B --type big -q --output-dir /custom/path

jgtapp

usage: jgtapp [-h] {tide,pds,cds,ocds,ttf,mlf,ttfmxwf,mx,ttfwf,fxaddorder,fxrmorder,entryvalidate,fxrmtrade,fxtr,fxmvstop,ids,fxmvstopgator,fxmvstopfdb} …

CLI equivalent of bash functions

positional arguments: {tide,pds,cds,ocds,ttf,mlf,ttfmxwf,mx,ttfwf,fxaddorder,fxrmorder,entryvalidate,fxrmtrade,fxtr,fxmvstop,ids,fxmvstopgator,fxmvstopfdb} tide Unified JGTML Alligator Analysis (now redirects to unified CLI) pds Refresh the PDS full for an instrument and timeframe cds Refresh the CDS ocds Refresh the CDS from old PDS ttf Refresh the TTF for an instrument and timeframe (TTF != Time-To-Future but more like feature of multiple timeframe) mlf Refresh the MLF for an instrument and timeframe ttfmxwf Refresh the TTF, MX and CDS for an instrument mx Refresh the MX (using the TTF) for an instrument and timeframe ttfwf Refresh TTF preparation for an instrument fxaddorder Add an order fxrmorder Remove an order entryvalidate Remove an order if it became invalid (e.g. stop rate hit) fxrmtrade Remove a trade fxtr Get trade details fxmvstop Move stop ids Refresh the IDS fxmvstopgator Move stop using gator fxmvstopfdb Move stop using fdb

options: -h, –help show this help message and exit

pncli

usage: patterncli [-h] [-clh COLUMNS_LIST_FROM_HIGHER_TF [COLUMNS_LIST_FROM_HIGHER_TF …]] [-pn PATTERNNAME] [-ls] [-json | -md] [-t TIMEFRAME]

Create or read pattern columns.

options: -h, –help show this help message and exit -t TIMEFRAME, –timeframe TIMEFRAME Timeframe

Patterns:

-clh COLUMNS_LIST_FROM_HIGHER_TF [COLUMNS_LIST_FROM_HIGHER_TF …], –columns_list_from_higher_tf COLUMNS_LIST_FROM_HIGHER_TF [COLUMNS_LIST_FROM_HIGHER_TF …] List of columns to get from higher TF. Default is mfi_sig,zone_sig,ao -pn PATTERNNAME, –patternname PATTERNNAME Pattern Name -ls, –list-patterns List Patterns

Outputs:

-json, –json_output Output in JSON format -md, –markdown_output Output in Markdown format

This tool is used to create patterns with their corresponding columns or read existing patterns from disk.

ttfcli

usage: ttfcli [-h] [-i INSTRUMENT] [-t TIMEFRAME] [-new | -old] [-c MAX | [-uf | -nf]] [-fr] [-clh COLUMNS_LIST_FROM_HIGHER_TF [COLUMNS_LIST_FROM_HIGHER_TF …]] [-pn PATTERNNAME] [-ls] [-json | -md]

Create ttf pattern.

options: -h, –help show this help message and exit -fr, –force_read Force to read CDS (should increase speed but relies on existing data)

POV: Point of view

-i INSTRUMENT, –instrument INSTRUMENT An instrument which you want to use in sample. For example, “EUR/USD”. -t TIMEFRAME, –timeframe TIMEFRAME Time period which forms a single candle. For example, m1 - for 1 minute, H1 - for 1 hour.

Bars: Bars flags

-new, –fresh Freshening the storage with latest market. -old, –notfresh Output/Input wont be freshed from storage (weekend or tests). -c MAX, –quotescount MAX Max number of bars. 0 - Not limited -uf, –full Output/Input uses the full store. -nf, –notfull Output/Input uses NOT the full store.

Patterns:

Outputs:

-json, –json_output Output in JSON format -md, –markdown_output Output in Markdown format

This is probably an intermediary dataset creator for a pattern that are used in the MLF and other modules and it might change over time as the pattern evolves.

mlfcli

usage: mlfcli [-h] [-lp LAG_PERIOD] [-tlp TOTAL_LAGGING_PERIODS] [-ctk COLUMNS_TO_KEEP [COLUMNS_TO_KEEP …]] [-ctd COLUMNS_TO_DROP [COLUMNS_TO_DROP …]] [-kba | -rmba] [-i INSTRUMENT] [-t TIMEFRAME] [-c MAX | [-uf | -nf]] [-new | -old] [-dv | -ddv] [-fr] [-clh COLUMNS_LIST_FROM_HIGHER_TF [COLUMNS_LIST_FROM_HIGHER_TF …]] [-pn PATTERNNAME] [-ls] [-json | -md]

Create MLF Data (alpha)

options: -h, –help show this help message and exit -fr, –force_read Force to read CDS (should increase speed but relies on existing data)

Lagging: -lp LAG_PERIOD, –lag_period LAG_PERIOD Lag period -tlp TOTAL_LAGGING_PERIODS, –total_lagging_periods TOTAL_LAGGING_PERIODS Total lagging periods

Columns Filtering: -ctk COLUMNS_TO_KEEP [COLUMNS_TO_KEEP …], –columns_to_keep COLUMNS_TO_KEEP [COLUMNS_TO_KEEP …] List of selected columns to keep -ctd COLUMNS_TO_DROP [COLUMNS_TO_DROP …], –columns_to_drop COLUMNS_TO_DROP [COLUMNS_TO_DROP …] List of selected columns to drop

Cleanup: Cleanup data

-kba, –keepbidask Keep Bid/Ask in storage. -rmba, –rmbidask Remove Bid/Ask in storage. -dv, –dropna_volume Drop rows with NaN (or 0) in volume column. (note.Montly chart does not dropna volume) -ddv, –dont_dropna_volume Do not dropna volume

POV: Point of view

Bars: Bars flags

-c MAX, –quotescount MAX Max number of bars. 0 - Not limited -uf, –full Output/Input uses the full store. -nf, –notfull Output/Input uses NOT the full store. -new, –fresh Freshening the storage with latest market. -old, –notfresh Output/Input wont be freshed from storage (weekend or tests).

Patterns:

Outputs:

-json, –json_output Output in JSON format -md, –markdown_output Output in Markdown format

MLF Is used to create lagging features. It uses the TTF data and creates lagging features for the given instrument and timeframe. If a pattern is given and dont exist, it will try to create it using TTF.

jgtmlcli

usage: jgtmlcli [-h] [-i INSTRUMENT] [-t TIMEFRAME] [-r TLIDRANGE] [-v VERBOSE] [-uf | -nf] [-new | -old] [-kba | -rmba] [-mfi | -nomfi] [-go] [-ba] [-bjaw BALLIGATOR_PERIOD_JAWS] [-ta] [-tjaw TALLIGATOR_PERIOD_JAWS] [-lfp LARGEST_FRACTAL_PERIOD] [-dv | -ddv] [-rcds] [-sc SELECTED_COLUMNS [SELECTED_COLUMNS …]] [-ddcc] [-pn PATTERNNAME]

Process command parameters.

options: -h, –help show this help message and exit -uf, –full Output/Input uses the full store. -nf, –notfull Output/Input uses NOT the full store. -rcds, –regenerate_cds Regenerate the CDS -sc SELECTED_COLUMNS [SELECTED_COLUMNS …], –selected-columns SELECTED_COLUMNS [SELECTED_COLUMNS …] List of selected columns to keep -ddcc, –dont_drop_calc_col Dont drop calculated columns -pn PATTERNNAME, –patternname PATTERNNAME Pattern Name

POV: Point of view

DTRange: Date and range selection

-r TLIDRANGE, –range TLIDRANGE TLID range are two dates formated: YYMMDDHHMM_YYMMDDHHMM.

Verbosity: control the verbosity of the output

-v VERBOSE, –verbose VERBOSE Set the verbosity level. 0 = quiet, 1 = normal, 2 = verbose, 3 = very verbose, etc.

Bars: Bars flags

-new, –fresh Freshening the storage with latest market. -old, –notfresh Output/Input wont be freshed from storage (weekend or tests).

Cleanup: Cleanup data

Indicators: Indicators flags

-mfi, –mfi_flag Enable the Market Facilitation Index indicator. -nomfi, –no_mfi_flag Disable the Market Facilitation Index indicator. -go, –gator_oscillator_flag Enable the Gator Oscillator indicator. -ba, –balligator_flag Enable the Big Alligator indicator. -bjaw BALLIGATOR_PERIOD_JAWS, –balligator_period_jaws BALLIGATOR_PERIOD_JAWS The period of the Big Alligator jaws. -ta, –talligator_flag Enable the Tide Alligator indicator. -tjaw TALLIGATOR_PERIOD_JAWS, –talligator_period_jaws TALLIGATOR_PERIOD_JAWS The period of the Tide Alligator jaws. -lfp LARGEST_FRACTAL_PERIOD, –largest_fractal_period LARGEST_FRACTAL_PERIOD The largest fractal period.

jgtcli

usage: jgtcli [-h] [-i INSTRUMENT] [-t TIMEFRAME] [-s “m.d.Y H:M:S”] [-e “m.d.Y H:M:S”] [-r TLIDRANGE] [-v VERBOSE] [-ads] [-c MAX | [-uf | -nf]] [-new | -old] [-mfi | -nomfi] [-go] [-ba] [-bjaw BALLIGATOR_PERIOD_JAWS] [-ta] [-tjaw TALLIGATOR_PERIOD_JAWS] [-lfp LARGEST_FRACTAL_PERIOD] [-vp] [-dv | -ddv] [-jsonf JSON_FILE] [-pdsrq] [-pdsrqn] [-pdsrqnf] [-pdsrqf] [-pdsrqff] [-idsrq] [-cdsrq] [-cdsrqf] [-cdsrqff] [-cdsrqnf]

JGTCLI Command Line Interface

options: -h, –help show this help message and exit

POV: Point of view

DTRange: Date and range selection

-s “m.d.Y H:M:S”, –datefrom “m.d.Y H:M:S” Date/time from which you want to receive historical prices. If you leave this argument as it is, it will mean from last trading day. Format is “m.d.Y H:M:S”. Optional parameter. -e “m.d.Y H:M:S”, –dateto “m.d.Y H:M:S” Datetime until which you want to receive historical prices. If you leave this argument as it is, it will mean to now. Format is “m.d.Y H:M:S”. Optional parameter. -r TLIDRANGE, –range TLIDRANGE TLID range are two dates formated: YYMMDDHHMM_YYMMDDHHMM.

Verbosity: control the verbosity of the output

-v VERBOSE, –verbose VERBOSE Set the verbosity level. 0 = quiet, 1 = normal, 2 = verbose, 3 = very verbose, etc.

Interaction: Interaction arguments

-ads, –ads Action the creation of ADS and show the chart

Bars: Bars flags

Indicators: Indicators flags

Output: Output arguments

-vp, –viewpath flag to just view the path of files from arguments -i -t. -jsonf JSON_FILE, –json_file JSON_FILE JSON filepath content to be loaded.

Cleanup: Cleanup data

-dv, –dropna_volume Drop rows with NaN (or 0) in volume column. (note.Montly chart does not dropna volume) -ddv, –dont_dropna_volume Do not dropna volume

RQ Pattern: RQ Pattern to use. Future practice to create request patterns to load into the args later.

-pdsrq, –pds_rq_base Use PDS_RQ JSON_BASE -pdsrqn, –pds_rq_normal Use PDS_RQ JSON_NORMAL -pdsrqnf, –pds_rq_normal_fresh Use PDS_RQ JSON_NORMAL_FRESH -pdsrqf, –pds_rq_full Use PDS_RQ JSON_FULL -pdsrqff, –pds_rq_full_fresh Use PDS_RQ JSON_FULL_FRESH -idsrq, –ids_rq_base Use IDS_RQ JSON_BASE -cdsrq, –cds_rq_normal Use CDS_RQ JSON_NORMAL -cdsrqf, –cds_rq_full Use CDS_RQ JSON_FULL -cdsrqff, –cds_rq_full_fresh Use CDS_RQ JSON_FULL_FRESH -cdsrqnf, –cds_rq_norm_fresh Use CDS_RQ JSON_NORM_FRESH

Basically deals with Indicators data and the signal generation

jgtfxcli

usage: It saves its data in JGTPY_DATA/pds folder, if –full JGTPY_DATA_FULL/pds [-h] [-i INSTRUMENT] [-t TIMEFRAME] [-r TLIDRANGE] [-vp] [-xe] [-z] [-c MAX | [-uf | -nf]] [-v VERBOSE] [-debug] [-iprop] [-server] [-kba | -rmba] [-dv | -ddv] [-pdsrq] [-pdsrqn] [-pdsrqnf] [-pdsrqf] [-pdsrqff] [-idsrq] [-cdsrq] [-cdsrqf] [-cdsrqff] [-cdsrqnf] [-jsonf JSON_FILE]

JGT Price History CLI

options: -h, –help show this help message and exit -xe, –exitonerror Exit on error rather than trying to keep looking -iprop, –iprop Toggle the downloads of all instrument properties -server, –server Run the server

POV: Point of view

DTRange: Date and range selection

-r TLIDRANGE, –range TLIDRANGE TLID range are two dates formated: YYMMDDHHMM_YYMMDDHHMM.

Output: Output arguments

-vp, –viewpath flag to just view the path of files from arguments -i -t. -z, –compress Compress the output. If specified, it will also activate the output flag. -jsonf JSON_FILE, –json_file JSON_FILE JSON filepath content to be loaded.

Bars: Bars flags

-c MAX, –quotescount MAX Max number of bars. 0 - Not limited -uf, –full Output/Input uses the full store. -nf, –notfull Output/Input uses NOT the full store.

Verbosity: control the verbosity of the output

-v VERBOSE, –verbose VERBOSE Set the verbosity level. 0 = quiet, 1 = normal, 2 = verbose, 3 = very verbose, etc. -debug, –debug Toggle debug

Cleanup: Cleanup data

RQ Pattern: RQ Pattern to use. Future practice to create request patterns to load into the args later.

----

# 🔄 Legacy Command Migration Guide

## ⚠️ Deprecated Commands → Unified Replacements

The following legacy commands have been **unified** into the new Alligator CLI system:

### Legacy Tide Alligator Commands (DEPRECATED):
```bash
# ❌ OLD (deprecated)
ptojgtmltidealligator -i SPX500 -t D1 --buysell S -nf --dont_regenerate_cds
jgtapp tide -i SPX500 -t D1 S

# ✅ NEW (unified)
python -m jgtml.alligator_cli -i SPX500 -t D1 -d S --type tide

Legacy Big Alligator Commands (DEPRECATED):

# ❌ OLD (deprecated)
ptojgtmlbigalligator -i EUR/USD -t H4 --buysell B -nf --dont_regenerate_cds

# ✅ NEW (unified)
python -m jgtml.alligator_cli -i EUR/USD -t H4 -d B --type big

Legacy Bash Function Migration:

# ❌ OLD (deprecated bash function)
jgtml_ptojgtmltidealligator_by_instrument_tf_21 SPX500 D1 S

# ✅ NEW (unified CLI - supports all Alligator types)
python -m jgtml.alligator_cli -i SPX500 -t D1 -d S --type tide

# 🚀 ENHANCED (multi-Alligator convergence analysis)
python -m jgtml.alligator_cli -i SPX500 -t D1 -d S --type all

Key Migration Benefits:

🔄 Graceful Pattern Handling: Automatically handles missing TTF patterns (zonesq)
🎯 Intent-Driven Analysis: Generate .jgtml-spec files for agentic workflows
🌐 Self-Contained: No external bash script dependencies
⚡ Multi-Type Convergence: Analyze all three Alligator types simultaneously
🔧 Backward Compatible: Legacy jgtapp tide commands automatically redirect

Legacy File References:

ptojgtmltidealligator.py → Replaced by unified alligator_cli.py
ptojgtmlbigalligator.py → Replaced by unified alligator_cli.py
Bash wrapper scripts → Replaced by unified Python CLI

This site is open source. Improve this page.