Command Reference

This page documents all available Tektii CLI commands, their arguments, and options.

Global Options

These options apply to all commands:

Verbosity Levels

strategy

Manage trading strategies.

strategy init

Scaffold a starter strategy directory from a template. Templates are fetched from the Tektii trading-gateway examples.

tektii strategy init [<TEMPLATE>] [<DIR>] [--force]

Available templates: ma-crossover, rsi-momentum. The catalog is fetched live from GitHub, so run the command with no arguments to see the current list:

# List the available templates
tektii strategy init

Examples:

# Scaffold the moving-average crossover example into ./ma-crossover/
tektii strategy init ma-crossover

# Scaffold into a custom directory
tektii strategy init ma-crossover my-bot

# Overwrite an existing, non-empty directory
tektii strategy init rsi-momentum my-bot --force

After scaffolding, a typical first run is:

cd ma-crossover
uv sync --all-extras                            # install dependencies
uv run pytest                                   # run the example test
tektii strategy create --name "ma-crossover"    # register it, note the strategy ID
tektii version upload <STRATEGY_ID>             # ship it

strategy create

Create a new trading strategy.

tektii strategy create --name <NAME>

Example:

tektii strategy create --name "momentum-v1"

strategy list

List all strategies with pagination support.

tektii strategy list [--limit <N>] [--cursor <CURSOR>]

Example:

tektii strategy list --limit 10

strategy get

Get details for a specific strategy.

tektii strategy get <STRATEGY_ID>

Example:

tektii strategy get strat_abc123def456

strategy delete

Delete a strategy and all its versions.

tektii strategy delete <STRATEGY_ID> [--yes]

Example:

tektii strategy delete strat_abc123def456 --yes

strategy set-auto-run

Set the list of scenario configurations that run automatically when a new version is uploaded for this strategy.

tektii strategy set-auto-run <STRATEGY_ID> --configs <CONFIG_IDS>

Examples:

# Run two configs on every new version
tektii strategy set-auto-run strat_abc123def456 \
  --configs cfg_xyz789,cfg_uvw321

# Clear the auto-run list
tektii strategy set-auto-run strat_abc123def456 --configs ""

version

Manage strategy versions.

version upload

Create a new strategy version — either by building and pushing a Docker image, or from a platform template that skips Docker entirely.

tektii version upload <STRATEGY_ID> \
  [--git-sha <SHA>] \
  [--dockerfile <PATH>] \
  [--context <PATH>] \
  [--parent <VERSION_ID>] \
  [--template <TEMPLATE>]

Process (Docker build):

1. Validates Dockerfile exists
2. Auto-detects git SHA (or uses timestamp fallback)
3. Creates version entry in API
4. Builds Docker image for linux/amd64 platform
5. Pushes image to registry

Process (--template):

1. Skips Dockerfile validation, Docker build, and registry push
2. Creates version entry in API and the server copies the template image into your strategy
3. Useful for first-run users who want a working strategy without configuring Docker

Examples:

# From strategy repository root
cd /path/to/my-strategy
tektii version upload strat_abc123def456

# With custom paths
tektii version upload strat_abc123def456 \
  --dockerfile ./docker/Dockerfile.prod \
  --context ./src

# Use a platform template (no Docker needed)
tektii version upload strat_abc123def456 --template ma-crossover

# Branch from an existing version
tektii version upload strat_abc123def456 --parent ver_xyz789

Provenance & branching: --git-sha is the traceability link back to your source — Tektii stores the built image and the commit SHA, not your code, so to compare two versions run git diff <shaA> <shaB> in your own repo. --parent records lineage, organising versions as a branching tree: you can branch a new experiment from any version, not just the latest.

version list

List versions for a strategy.

tektii version list <STRATEGY_ID> [--limit <N>] [--cursor <CURSOR>]

Example:

tektii version list strat_abc123def456

version get

Get details for a specific version.

tektii version get <STRATEGY_ID> <VERSION_ID>

Example:

tektii version get strat_abc123def456 ver_xyz789

scenario

Manage backtest scenarios.

scenario create

Create a new backtest scenario from a JSON configuration file.

tektii scenario create <STRATEGY_ID> --config <FILE>

Example:

tektii scenario create strat_abc123 --config ./backtest-config.json

scenario list

List scenarios for a strategy.

tektii scenario list <STRATEGY_ID> [--limit <N>] [--cursor <CURSOR>]

Example:

tektii scenario list strat_abc123

scenario get

Get details for a specific scenario.

tektii scenario get <STRATEGY_ID> <SCENARIO_ID>

Example:

tektii scenario get strat_abc123 scen_def456

scenario download

Download backtest results (metadata, timeseries, or trades).

tektii scenario download <STRATEGY_ID> <SCENARIO_ID> [options]

*Required for timeseries and trades result types.

Examples:

# View metadata in terminal
tektii scenario download strat_abc123 scen_def456

# Save metadata to a file (always written as JSON)
tektii scenario download strat_abc123 scen_def456 \
  --file metadata.json

# Download full timeseries
tektii scenario download strat_abc123 scen_def456 \
  --result-type timeseries \
  --file timeseries.json

# Download trade log
tektii scenario download strat_abc123 scen_def456 \
  --result-type trades \
  --file trades.json

config

Manage reusable scenario configurations.

config create

Create a reusable scenario configuration.

tektii config create --name <NAME> --file <FILE>

Example:

tektii config create \
  --name "2023-backtest" \
  --file ./config.json

config list

List your configurations.

tektii config list [--limit <N>] [--cursor <CURSOR>]

Example:

tektii config list

config get

Get details for a specific configuration.

tektii config get <CONFIG_ID>

Example:

tektii config get cfg_xyz789

config update

Update an existing configuration.

tektii config update <CONFIG_ID> --file <FILE>

Example:

tektii config update cfg_xyz789 --file ./updated-config.json

config delete

Delete a configuration.

tektii config delete <CONFIG_ID> [--yes]

Example:

tektii config delete cfg_xyz789 --yes

Next Steps

• Authentication - Configure your API key
• Read Workflow - List strategies and download results
• Write Workflow - Push Docker images as versions