CLI and file reference
algo run flags
Single-run mode (mutually exclusive with --config, except the flags the config-mode table below lists, --bar-interval and --initial-capital among them):
| Flag | Default | Meaning |
|---|---|---|
--adapter PATH|NAME | (discovered) | Data adapter: a path, or the name of an adapter in the adapter directory. Empty asks every adapter in the directory and runs the one that can serve the run; see Finding the adapter. |
--adapter-inputs k=v[,k=v...] | Adapter inputs (e.g. Path=...). | |
--data-protocol | auto | Data wire: auto, dbn, pb, csv. auto tries dbn, then pb, then csv, demoting dbn for what it cannot carry (a session, a path, an activity kind, a composite) and moving pb to the front when the run wants what travels on it alone (an equity’s corporate actions, an exchange calendar, a lead-in, the final settlement of a dated futures contract under lifetime v2); a named wire is honoured as given. See Process boundaries. |
--strategy PATH | (required*) | Strategy binary. *Optional with --schema TRADES. |
--strategy-protocol | auto | Strategy wire: auto, pb, csv. Under lifetime v2 (a backtest’s default), auto offers stdio-csv-v2 between pb and CSV v1, and csv offers stdio-csv-v2 ahead of CSV v1 (see Negotiating stdio-csv-v2). |
--strategy-stall-timeout | 0 (off) | How long the strategy may keep the engine waiting, for its next reply frame or to take what the engine writes, before the run is cancelled; each frame it sends ends a wait, a log line is not a reply, and a warm-up chunk is one wait. 0 leaves it off; a negative value is refused (engine: strategy-stall-timeout must not be negative (0 = off), got -1s). Config key data.strategy-stall-timeout. See Stopping a run. |
--inputs k=v[,k=v...] | Strategy input values. A value may hold commas, as a spread symbol does (Stocks=spr:1*macro:EIA:WCESTUS1,1*macro:EIA:WGTSTUS1): a piece that does not open with an input name and = continues the value before it (GLE-1424). The same holds for --adapter-inputs. | |
--symbols A[,B...] | (required) | Symbols; ONE instance receives every symbol’s series. |
--symbol SYM | Deprecated single-symbol alias for --symbols. | |
--session | empty | Trading-day container (eth, rth, or session; names are case-insensitive, GLE-1327) for 1d/1w time bars, or a custom exchange-local window custom:HHMM-HHMM for 1d bars (see Custom session windows), or an intraday grid boundary (utc-day, eth, rth, or session) with an intraday interval. A continuous run accepts the trading-day container at 1d/1w (it reads the feed’s session composite, eth when none is given; see --continuous-clock) and, since GLE-443, an intraday grid (it reads the feed’s grid composite; see Continuous symbols on a grid); its symbol carries no @ session suffix. A release-stamped series (cot:, macro:, fx:RBA:) never takes it (GLE-536). |
--bar-interval | 1d | Bar interval (1s/5m/1h/1d/1w style); time bars only. The default was 1m before GLE-1411. |
--bar-kind | time | One of the fourteen kinds (see Bars beyond time). |
--threshold | 0 | Activity-bar close threshold, in the kind’s unit. |
--reversal-mult | 0 (= 2.0) | Renko reversal as a multiple of the brick size. |
--threshold-mode | static | Imbalance/runs: static or expectation. |
--ewma-span-bars | 0 | Expectation mode: EWMA span for expected bar size. |
--ewma-span-signal | 0 | Expectation mode: EWMA span for the signed rate. |
--init-expected-size | 0 | Expectation mode: expected-bar-size seed. |
--init-signed-rate | 0.5 | Expectation mode: signed-rate seed, in [0,1]. |
--lead-in | 0 | Event bars: constructor warm-up. The adapter feeds trades from the start minus this and discards the bars that close before the start (see Constructor lead-in). Refused on time bars and with a negative value. |
--initial-capital | 100000 | Simulator starting cash: an amount (100000) or one with its currency (USD100000, 100000USD). The currency must be the account’s (--base-currency); the flag does not change it. |
--base-currency | USD | The account’s currency (ISO 4217, GLE-391). Capital is in it, and so is commission unless it names another; an instrument quoted in another currency is converted at the RBA rate in force. A config file names it as the initial-capital currency. See Currencies. |
--margin-model | report | The simulator’s margin model (GLE-411): report (lock and report the margin the positions require and record margin calls, denying nothing), enforce (also deny an order that grows a position the net liquidation cannot carry at initial margin) or off. Config key margin-model. See Margin. |
--commission-per-order | 0 | Flat commission per fill: an amount in the account’s currency (1.50), or one with its currency (EUR1.50, 1.50EUR), which each fill converts into the account’s at the RBA rate in force (GLE-1413). Refused with --config, whose commission-amount carries the commission. |
--commission-per-share | 0 | Commission per share/contract, in the form of --commission-per-order. The two amounts that are not zero must share one currency. |
--slippage-ticks | 0 | Adverse slippage in ticks (x each symbol’s tick size) on market-style fills. |
--bracket-ambiguity | conservative | Same-bar bracket convention: conservative, optimistic, path_direction. Config key data.bracket-ambiguity; with --config, the default of a run that does not set the key (Fill settings per run). |
--limit-fill | conservative | Limit fill rule: conservative (trade-through at tick resolution, touch at bar/path), through (trade-through at every resolution; a backtest, or a member on a SIM desk) or optimistic (touch; diagnostic). Config key data.limit-fill; with --config, the default of a run that does not set the key. |
--simulation-resolution | auto | auto, tick, or bar. Config key data.simulation-resolution; with --config, the default of a run that does not set the key. |
--gtc-expiry | never | Fill simulator: the venue GTC termination model. never rests a GTC order until it fills, is cancelled or the run ends (byte-identical to before the flag); ibkr-quarter cancels it, reason GTC_EXPIRED, before the first bar whose trade date falls after the end of the calendar quarter following its submission’s trade date, or, under lifetime v2 with the root’s exchange calendar, at the calendar’s close of the quarter’s final trading day (Calendar cancellation instants (lifetime v2)). A live venue applies its own rule, and the flag then prints one note. No config key. See GTC quarter-end cancellation. |
--lifetime | empty (= v2 for a backtest, v1 live) | Order lifetime profile. Empty, the default, selects v2 for a backtest, plain or continuous, and v1 for --mode live and --schema TRADES (GLE-470); under the backtest default a strategy that does not accept lifetime-v2 is refused at the handshake with a hint naming --lifetime v1. v1 is the legacy profile, byte-identical to the default before GLE-470, and the rollback. v2, named or by default, offers lifetime-v2 in Init (the strategy must accept it), answers every submission with an OrderUpdate and every cancel request with a CancelResponse, grants lifecycle turns per instant, on the pb wire gives a strategy a decision at each timer it arms (Scheduled decision points), on a backtest cancels working orders across the corporate actions IBKR cancels them on (Corporate actions and working orders (lifetime v2)), expires dated futures contracts at their expiration, cancelling their orders and settling their positions at the exchange’s final settlement (Contract expiry (lifetime v2); the auto data wire then prefers pb for a run holding a dated contract, since the settlement travels on the statistics stream), with the run’s exchange calendars ends a Day order at its session’s close and a GTC order at the quarter’s final trading close (Calendar cancellation instants (lifetime v2)), and on a continuous backtest re-places the orders a roll carries as new attempts the strategy is told of (Order lifetime v2 across a roll); backtest (plain or continuous) and emulated-live strategy runs on the pb wire or stdio-csv-v2 (not CSV v1), refused under --schema TRADES. The report’s lifetime: line, result.json, report.html and the lifecycle trace record the profile and its source (default or explicit) when it is v2 or defaulted; a run under --lifetime v1 records neither. Config key data.lifetime. See Lifecycle turns. |
--lifetime-turns | 0 (= 3) | Under lifetime v2: lifecycle turns granted per instant, and per timer decision; 0 selects the default, 3, and a negative value is refused. The outcomes of the last permitted turn’s commands are deferred to the next event on a backtest and delivered at once, without a turn, on a live run; either way 2 is the smallest budget under which a turn’s own outcome can grant another. Config key data.lifetime-turns. |
--lifetime-hold-timeout | 0 (= 5m) | Under lifetime v2: how long the admission race guard holds an order behind a pending cancellation before rejecting it with hold_timeout, on the run’s event clock (bar closes and timer instants), a hold as old as the timeout included; 0 selects the default, five minutes, and a negative value is refused (engine: order lifetime v2 needs a hold timeout above zero (0 selects the default 5m0s), got -1s). Ignored on a v1 run. Config key data.lifetime-hold-timeout. See The engine race guard. |
--max-working-orders | 0 (no limit) | Under lifetime v2 (a backtest’s default): the admission policy’s limit on the instance’s working orders, held, pending-cancel and unknown ones and labelled attached orders included (cap_working_orders). A negative value is refused, and so is any admission limit on a v1 run (--lifetime v1, or a live run that names no profile). Config key data.max-working-orders. See The admission policy. |
--max-symbol-working-orders | 0 (no limit) | Under lifetime v2: the same limit on the working orders on each symbol (cap_symbol_working_orders). Config key data.max-symbol-working-orders. |
--max-order-quantity | 0 (no limit) | Under lifetime v2: the limit on the quantity of one order and of each attached order (cap_quantity). Config key data.max-order-quantity. |
--max-position | 0 (no limit) | Under lifetime v2: the limit, either way, on the position each symbol could reach if every working and held order executed, checked only at the end an order extends (cap_exposure). Config key data.max-position. |
--director FILE | — | The trade director (GLE-532): a JSON file holding {"director": {...}}, with // and # comments allowed. With --config it replaces every run’s director. Needs lifetime v2. Config key director. See Trade director. |
--director-json JSON | — | The same {"director": {...}} value inline, for a single run without a file. Not with --director. |
--director-log PATH | — | Where the trade director’s decision log goes. With --config it must contain {run}, replaced by each run’s ID. Default: director-decisions.jsonl in the run’s results directory, or <ledger>.director.jsonl beside a live run’s ledger file (a deployed member, whose ledger the desk journal keeps, uses the results directory); a backtest that exports (--export) with neither keeps it in the export alone. See Trade director. |
--director-control FILE | — | The trade director’s owner control events (resume, reduce, reset-peak, reset-ladder, reset-period), one JSON object per event, read once when the run starts; {run} is replaced by the run’s ID. Needs a director. See Owner control events. |
--max-submissions | 0 (no budget) | Under lifetime v2, with --submission-window: the budget of new orders the policy accepts per window of event time (rate_budget); the two are set together. Config key data.max-submissions. |
--submission-window | 0 (no budget) | Under lifetime v2, with --max-submissions: the window of event time (a Go duration) the budget covers. Config key data.submission-window. |
--transport-requests | 0 (= 5) | With --lifetime v2, live: the transport scheduler sends at most this many submissions and cancel requests to the venue within any --transport-window of the run’s operational clock (bar closes on today’s stepped loop, so per bar), queued cancel requests first; 0 selects the default, 5. A negative value is refused, and so is any transport limit on a v1 run; a v2 backtest has no venue transport and ignores the three. Config key data.transport-requests. See The transport scheduler. |
--transport-window | 0 (= 1s) | With --lifetime v2, live: the window (a Go duration) --transport-requests covers, and the pause after the venue refuses a request for pacing; 0 selects the default, one second. Config key data.transport-window. |
--transport-queue | 0 (= 100) | With --lifetime v2, live: the most submissions the transport scheduler queues; a submission that finds the queue full is refused (transport_overload), and cancel requests are not counted; 0 selects the default, 100. Config key data.transport-queue. |
--include-path | off | Request each coarsened bar’s intra-bar path (BARS_TIME; serves_path adapters only) and use it for bar-resolution fills. The path stays private to the engine: the strategy receives plain bars. A continuous symbol, a bare root or a :cont composite, walks the path of the contract it holds, a bar containing a roll from the cut (GLE-1332, Path resolution). On a trading-day session, and on a continuous 1d series with none, it needs --path-interval beside it (A session bar’s path); a continuous 1w series refuses it (continuous_path_unavailable). Config key data.include-path; on a series’ own construction, include-path. See Which level a bar reached first. |
--path-interval | empty | Exact constituent interval, e.g. 1m; implies --include-path. Unavailable or structurally invalid paths are refused, and so is a continuous 1w series (continuous_path_unavailable). On a 1d trading-day session the edge constituents are clamped to the session’s open and close, so they can be shorter (A session bar’s path). The run reads the constituents of its whole window (a 30-minute bar carries thirty 1-minute bars). Config key data.path-interval; on a series’ own construction, path-interval. |
--accept-degraded-seams | off | Continuous futures: trade across a served roll seam whose pair is a fallback (degraded) instead of refusing the run (SEAM_DEGRADED); recorded in degradation.json and on the manifest pin (GLE-323). A refused run records the root and the seam in degradation.json as degraded_roll_seam_refused. Config key accept-degraded-seams. |
--roll-rebase | on | Continuous futures: re-adjust each series at every roll, so the strategy calculates on prices adjusted only by the rolls that have happened (GLE-1458). On by default (GLE-1502): left unset, a run rebases when its strategy accepts the roll-rebase capability and otherwise runs without it, saying so in a Data note; given explicitly, a strategy that can’t take it is refused; --roll-rebase=false turns it off. Its bars are the held contract’s own prices, each roll sends it the series’ history on the incoming basis, and its orders and costs are restated; the report stays in the served frame. Runs under either order lifetime and with a trade director (GLE-1503). Needs the stdio-pb-v1 or stdio-csv-v2 strategy wire (GLE-1505). Aligned views of a continuous series are rebuilt at each roll, and the portfolio view is in the held contract’s prices (GLE-1504). A continuous series on --feed stream needs it. Recorded as RollRebase in result.json only when the run rebased, with RollRebaseSource (default or explicit). Config key roll-rebase; deployment key roll_rebase. See Re-adjusting at each roll. |
--continuous-clock | session | Continuous futures: session reads the feed’s trade-date session composite for a 1d/1w series (under --session, or eth when none is given) and UTC epoch buckets for an intraday interval; epoch reads epoch buckets at every interval and takes no session (the daily clock before GLE-324). A session together with the epoch clock, or any other value, is refused before any spawn. Config key continuous-clock. |
--exchange-calendar | off | Fetch the exchange calendar of every root the run reads (pb data wire; auto negotiation then prefers pb), push it to a strategy that asks for it and record it in the run’s provenance (result.json, --fills-json, --lifecycle-json), with no pin. A strategy that sets needs_calendar turns the fetch on by itself. Every bar of a root served a calendar is then checked against it, and a bar that disagrees refuses the run (calendar_data_disagree; see Conformance checks and admission). Refused under --schema TRADES, as is every calendar option. Config key data.exchange-calendar. See Engine side. |
--calendar-revisions root=rev[,root=rev...] | empty | Exchange-calendar pins: a served revision that differs, or no calendar served for a pinned root, refuses the run (calendar_pin_drift); a pin for a root the run does not read is ignored. Config key data.calendar-revisions, an object of root to revision. |
--strict-calendar | off | Require every symbol the run reads to have a calendar root with a pin and a served calendar that matches it (calendar_pin_drift). Config key data.strict-calendar. |
--calendar-accept-unverified root[,root...] | empty | The roots whose unrecorded session eras precise-time admission accepts (D-I11-4); it waives calendar_incomplete’s eras-unrecorded reason only; admission’s one caller today is the arm of a session-anchored timer, and the simulator’s calendar cancellation instants apply the same rule under the list (see Conformance checks and admission, Scheduled decision points and Calendar cancellation instants (lifetime v2)). Config key data.calendar-accept-unverified, an array. |
--calendar-margin-quarters | 0 (= 2) | How many calendar quarters past the run’s last bar the exchange-calendar fetch reaches; 0 selects the default, 2, and at most 40. Config key data.calendar-margin-quarters. |
--path-heuristic | empty | Bar-resolution path assumption: midpoint walks open, high, low, close when the open is strictly above the bar’s midpoint, otherwise open, low, high, close (the extreme nearer the open first); legacy reproduces the legacy engine’s comparison bug for bug (almost always the high first); empty treats each bar as one ambiguous OHLC interval, where two same-kind members of an OCO group tie and the first submitted fills. A real path wins. See Which level a bar reached first. |
--auto-lineage | off | Follow each equity series’ rename chain forward and run it as one instrument lineage; a discovered successor inherits the head’s adj= qualifier, interval and session. |
--mode | backtest | backtest uses the simulator; live selects the IBKR venue path. |
--feed | history | Live mode: where the run’s bars come from. history steps the bars fetched before the run starts; stream takes them from the adapter’s real-time feed as they close (Running live on a real-time feed). stream needs --mode live and an adapter that streams bars. A deployment file’s feed key sets it for a member. |
--venue-url URL | Required with live mode: IBKR gateway or emulator base URL. | |
--venue-account ID | venue-selected | Live IBKR account; empty asks the venue for its selected account. |
--venue-emulated | off | Drive the deterministic IBKR emulator clock. Required by live mode, except for a member run against the desk (--deploy); a run straight against a broker gateway is refused, since the desk owns the broker connection. |
--ledger PATH | Required with live mode: durable order identity and reconciliation ledger. | |
--on-orphan | exit | Live startup policy for an unexplained broker order. Only exit is supported. |
--deployment LABEL | algo | Live mode: the ledger’s deployment label, 1–40 characters from [A-Za-z0-9_]. The ledger pairs it with a nonce drawn once when it is created, and every order reference (the IBKR cOID) is <label>-<nonce>-<n>; a ledger created under another label refuses to open. Config key data.deployment. See The order ledger. |
--ledger-migration | empty | Live mode: exclusive-owner accepts a ledger written before deployment identity existed (every reference c-<n>) on the operator’s assertion that no other deployment on the account allocated references under that prefix, recording the prefix as owned; empty refuses such a ledger. Config key data.ledger-migration. |
--venue-reply-allow | empty (= o10151,o10152,o10153,o10331,p12) | Live mode, both lifetime profiles: the IBKR order reply message ids the venue confirms, comma-separated. A reply carrying any other id, or none, is declined, and its order denied with IBKR’s text (reply_declined). none confirms no reply; empty selects the default, IBKR’s five general risk disclosures, so every precaution is declined. Each id is 1 to 32 ASCII letters and digits, listed once and matched exactly; the list is checked before any spawn on every run, a backtest included, which ignores it. Config key data.venue-reply-allow, a list ([] confirms no reply). See Order reply messages. |
--date-from / --date-to | open range | The run’s date range: each a date (YYYY-MM-DD) or an RFC 3339 timestamp; see The date range. --start and --end are removed and say so. |
--replicate | 1 | Total copies of the fetched bars (benchmarking; time bars only). |
--batch-size | 4096 | Records per data response envelope. |
--schema | BARS | BARS, or TRADES for a data-plane benchmark with no strategy. |
--run-id | derived | Run identifier (default run-<symbol>-<interval>, symbols joined by +, a continuous symbol slugified; mixed intervals give run-<label>+<label>, an event-bar run run-<symbol>-<kind>). |
--fills-json PATH | Backtest fill blotter and summary equity in JSON, used for reproducible comparisons. | |
--lifecycle-json PATH | Backtest strategy runs only: the order lifecycle trace, schema algolang.lifecycle/1 — every submission in the strategy’s and the venue’s frames, every cancel request, every venue fill and cancel, each continuous roll and its roll_account record (GLE-459), each dated futures contract’s expiry (lifetime v2, GLE-479), each strategy timer’s arm, disarm, fire and refusal (lifetime v2), each trade director decision (director_decision, with a director, which also links the trace’s refusals before the venue to its decision log), the working set before the end-of-data cancellation, 25 summary counts (plus roll_replaced, roll_lost, roll_expired, roll_held_refused, contract_expiries, calendar_cancels, scheduled_cancels and director_decisions when not zero, and the timer counts on a run with timers) and the fill blotter. Refused in live mode and under --schema TRADES; no config key. See The order lifecycle trace. | |
| `–report on | off` | on |
--plate P[,P...] | empty (= symbols,equity,returns on a terminal, else full) | What the run prints (GLE-1329, GLE-1410), in the order named, each once: symbols, strategies or sides (the slice tables), equity (the equity curve), returns (the monthly returns), summary (the summary plate), notes (the data notes), stats (the statistics) or full (the full report with its BENCH line). --plates is another name for it. With --config it chooses for the set. See Choosing what a run prints. |
| `–color auto | always | never` |
| `–chart braille | blocks | lines` |
--position-cost | false | The equity chart draws what the open positions tie up as a dim line, in colour. See The position cost line. |
--benchmark BENCHMARK | none | What the run is compared with (GLE-1374): a symbol to hold, a rate to hold cash at, a mix with shares (60% fut:XCME:ES + 40% fut:XCBT:ZN), or a JSON file of benchmarks. Repeat it for several; the first is the primary; off for none. The slice tables show it. See Choosing benchmarks. |
--risk-free-rate | 0 | Annual decimal risk-free rate for the performance report’s Sharpe and Sortino ratios. |
| `–roll-trades stitch | split` | stitch |
| `–equity-sampling daily | bar` | daily |
--results-dir DIR | Per-run artefact root: each run writes DIR/<run-id>/ with result.json, equity.csv, trades.csv, books.csv and report.html, the run set writes index.json, slices.json and slices-equity.csv, and a set of two or more runs writes portfolio/ (Saving the results). A run with combo orders also writes combo_trades.csv (Combo orders). Continuous runs may write manifest.yaml, audit.jsonl, and a conditional degradation.json; a run of several continuous series writes each series’ manifest and ledger under continuous/<series>/ (GLE-425). | |
--export FILE | Write the run, or with --config the set, to one self-contained .algorun export as it runs (GLE-672): the bars each run delivered to its strategy, warm-up included, its equity at every bar, every fill, its trades and the rest. With --results-dir or without it; the results directory is the same either way. The file appears only once the set has ended; a set that stops at a failed run leaves none. Refused for a live run, under --schema TRADES and with --report off. Config key report.export, which the flag overrides. See Writing the export as the set runs. | |
--cache | on | Bar-series disk cache: off, on, or refresh (bypass reads, rewrite entries). Engages only for backtests with a fully historical --date-to; see “The series cache”. Env fallback ALGO_CACHE applies when the flag is not given. |
--cache-dir DIR | ~/algolang/cache | Cache directory. Env fallback ALGO_CACHE_DIR. |
--symbol-registry and --served-roll-schedules were removed by ER3 (GLE-325, owner Decision 4): algo run treats either as an unknown flag (flag provided but not defined), and the config keys symbol-registry and data.served-roll-schedules, refused for one release, are since ER5 (GLE-327) unknown fields ignored with a warning. A continuous run names the bare root fut:<VENUE>:<ROOT> or the composite fut:<VENUE>:<ROOT>:cont:adj=<panama|ratio|none>; see How continuous contracts are stitched. The config keys data.adjustment-mode and data.dividend-treatment are refused the same way for one release (GLE-328, GLE-228 Decision 5a): the equity price view is named on the symbol, eq:<VENUE>:<TICKER>:adj=split or adj=splitdiv, and there was no flag for it.
--bar-interval and --initial-capital work in both modes (GLE-1411, GLE-1412): they set a single run’s interval and starting cash, and override a config’s. --interval and --capital, their older names, still work in both modes as aliases, though algo run -h does not list them. A flag given under both names is refused unless the two values agree.
Config mode:
| Flag | Meaning |
|---|---|
--config FILE | Run-config JSON file (see Config files and run matrices). Excludes all single-run flags. |
--verify | Validate and print the expanded plan and run each run’s pre-flight checks against its adapter, as algo run does before its first fetch; execute nothing. Prints the error under any run that would fail, omits OK and exits non-zero. |
--date-from / --date-to | Override every run’s date range: each a date (YYYY-MM-DD, --date-to inclusive) or an RFC 3339 timestamp. |
--initial-capital | Override the capital pool (e.g. USD100000), which capital-units shares between the runs. Unset, the config’s own initial-capital applies. |
--session | Override every run’s session: a trading-day container, or an intraday grid boundary. It never reaches a release-stamped series (cot:, macro:, fx:RBA:). |
--bar-interval | Override every run’s bar interval. Unset, each run’s own bar-interval applies, else 1d. |
--results-dir | Override the global per-run artefacts directory (global-only setting). |
--cache / --cache-dir | Override the global cache / cache-dir settings (global-only). |
| `–report on | off` |
--risk-free-rate | Override the global report.risk-free-rate (annual decimal, Sharpe and Sortino). |
| `–roll-trades stitch | split` |
| `–equity-sampling daily | bar` |
--export FILE | Override the global report.export: write the set to this .algorun file as it runs. The set then keeps going past a failed run unless report.keep-going is false. |
--plate P[,P...] (or --plates) | What the set prints, as in single-run mode; the equity curve, the monthly returns and summary are the portfolio’s for a set of two or more runs. |
| `–color auto | always |
| `–chart braille | blocks |
--position-cost | The position cost line on the equity chart, as in single-run mode. |
--benchmark BENCHMARK | Replace the configuration’s benchmarks, its report.benchmark switch included, as in single-run mode: repeat it for several, off for none (Choosing benchmarks). |
--director, --director-json, --director-log, --director-control | The trade director’s flags, as in single-run mode: --director or --director-json replaces every run’s director, and --director-log must contain {run}. |
report.keep-going (config) | Carry the set past a failed run; on by default when the set exports, off otherwise. See When a run of a set fails. |
report.benchmark (config) | Benchmark comparison; default true. false restores the pre-benchmark artefacts byte-for-byte. In place of true or false, the benchmarks themselves: one written out, a JSON file’s path, one benchmark’s object or a list (Choosing benchmarks). |
report.benchmarks (config) | The benchmarks to compare against; a list of hold baskets, rate cash balances, mixes and benchmarks written out, exactly one primary. Defaults to Long ES, ES/NQ 50:50 and 3M-T-Bill cash. A sleeve the feed refuses is skipped with a warning and named as excluded on the page (GLE-324 W10); see Report benchmark findings. |
Deploy mode:
| Flag | Meaning |
|---|---|
--deploy FILE | Run a deployment against the desk: the deployment file names the portfolio file, the mode, the desk’s URL and the members, each by its run’s id; the desk journal keeps each member’s ledger. Starts every member together, each in an algo process of its own, under a supervisor that prefixes each member’s lines with its id and starts a crashed member again. See Running a deployment against the desk. Excludes --config and every single-run flag except --member, --date-from, --date-to, --results-dir, --plate, --color and --chart. |
--member ID | With --deploy: run that member alone, in this process, without the supervisor; nothing starts it again if it fails. The supervisor starts each member this way. |
Also: algo version prints the build ID, algo cache [stats|list|flush] manages the series cache (see “The series cache”), and algo report <results-dir> [--runs id1,id2] [--partial] [--out DIR] [--format text|json] [--plate P[,P...]] [--color auto|always|never] [--chart braille|blocks|lines] [--risk-free-rate R] prints saved run results again and recombines any subset of them offline (see Reading saved results again: algo report).
Strategy executable flags
Every SDK strategy answers --algolang-describe (JSON schema), --algolang-version (SDK version), and --algolang-selftest (200 synthetic bars; exits non-zero on any error). Any other --algolang-* flag is an error.
The algolang tag, condensed
algolang:"default=V,min=V,max=V,by=V,desc=TEXT,values=[a,b,c],required"
Comma-separated; values excludes min/max/by; single quotes protect commas in free text (desc='Max positions, long and short'); field types int, int64, float64, bool, string, time.Duration; tagged fields must be exported.
File formats
Bar CSV (file-csv adapter, csv2bars output): symbol,ts_open,ts_close,open,high,low,close,volume header, RFC 3339 timestamps, plain decimal floats, one bar per line, single interval per file.
Databento trades CSV (databento adapter, csv2dbn/csv2bars/ replicate input): the standard Databento trades export – header ts_recv,ts_event,rtype,publisher_id,instrument_id,action,side,depth,price,size,flags,ts_in_delta,sequence,symbol, epoch-nanosecond timestamps, fixed-point prices scaled by 1e-9.
DBN (databento adapter, csv2dbn output): Databento’s binary format, auto-detected by the adapter from the file content.
Export file (.algorun): one SQLite file holding a run set, written by algo run --export as the set runs or by algo export from a results folder; see The export file.
Fill blotter (--fills-json): one JSON object with capital, equity, realized and fills, the simulator’s fill reports (BrokerOrderID, Fill, Anchor, and the fill’s bar anchor, Series and BarTime, which a corporate action’s legs, filled on no bar, do not have; a Fill carries Name, its order’s name, when the order had one, GLE-666; a held market-on-close order’s report carries SentAs and SendAt, GLE-1375, Market-on-close orders), preceded by calendars, the run’s exchange-calendar provenance, when the run asked for exchange calendars (Engine side; absent otherwise). The lifecycle trace repeats the four as its last four keys; see the next section.