CLI Reference¶

Invocation¶

analogcli [GLOBAL OPTIONS] <COMMAND> [ARGS] [OPTIONS]

Run analogcli --help to see the list of all commands. Authentication is read from the ANALOGCLOUD_API_KEY environment variable; the CLI exits with an error if the variable is unset or empty. For details on the individual options, see below.

Global options¶

Top-level commands¶

analogcli status¶

Synopsis: analogcli status

This command takes no arguments and no options beyond the globals. It prints the deployment domain, software version, uptime, and a table of devices showing Name, Type, Status, and Queue Length.

analogcli info¶

Synopsis: analogcli info DEVICE_NAME [--short] [--save-entity PATH]

By default the command prints the summary table followed by the pybrid entity tree. SIMULATOR devices never render an entity tree (their entity is null), so --short is a silent no-op on them.

analogcli compile¶

Synopsis: analogcli compile ODE_FILE [MODULE_FILE] [OPTIONS]

Exactly one of MODULE_FILE or --device is required. With --follow (the default), the CLI prints the submission status, polls the task to completion, dumps the logs, and then writes (or summarises) the compiled module.

analogcli run¶

Synopsis: analogcli run MODULE_FILE [OPTIONS]

With --follow, the CLI prints the submission status, polls to completion, dumps the logs, and on success either prints the result or writes it to --output.

analogcli task subgroup¶

All task subcommands take a TASK_ID (UUID, positional) unless noted, and they honour the global -u/--timeout options.

task search¶

Synopsis: analogcli task search [OPTIONS]

Search your own tasks within a datetime window, with optional filters by device, type, and state. Unlike task list, it includes a user_id column in its output and supports CSV export for reporting use cases.

Repeatable filter options combine with OR within a single field and AND across different fields. For example, --type run --type compile --state QUEUED returns tasks that are (run OR compile) AND in state QUEUED. A filter that is not specified is unconstrained. The server rejects a datetime window wider than 90 days.

The time window can be given either as an explicit --from/--to pair or as one of the --last-h/--last-d/--last-m shortcuts (a window ending "now"). These two styles are mutually exclusive, and at most one --last-* option may be used at a time; mixing them is a usage error. To pin --to to the current moment with an explicit start, generate the ISO timestamp with the Linux date command, e.g. --to "$(date -u +%Y-%m-%dT%H:%M:%S)".

Output columns vary by mode:

• Default (thin): id, user_id, type, state, created_at, error.
• With --recursive (rich): the thin columns plus device_name, backend, sample_rate, op_time, k0, has_result, has_log. Fields that do not apply to a task type (e.g. compile jobs have no device_name, run jobs have no backend) are left blank.

The user_id column is what distinguishes task search output from task list, which is always self-scoped and omits that column.

# All of the current user's jobs in the last 24 hours (default window).
analogcli task search

# The last 6 hours / 7 days / 90 minutes (shortcut for a window ending now).
analogcli task search --last-h 6

# Pin the window end to the current moment with an explicit start.
analogcli task search --from 2026-05-01T00:00:00 --to "$(date -u +%Y-%m-%dT%H:%M:%S)"

# Export a week of run jobs on a specific device to CSV.
analogcli task search \
    --type run \
    --device mredac \
    --from 2026-05-01T00:00:00 \
    --to 2026-05-08T00:00:00 \
    --csv runs.csv

# Full metadata report for your failed jobs.
analogcli task search --state FAILED --recursive --csv failures.csv

Exit codes¶

Quick-start example¶

# 1. Check what's available.
uv run analogcli status

# 2. Inspect a device.
uv run analogcli info lucistack

# 3. Compile an analang ODE (.ana file, see redacc docs) for a specific device (single-step flow).
uv run analogcli compile harmonic.ana --device lucistack --output harmonic.apb

# 4. Run the compiled module.
uv run analogcli run harmonic.apb \
    --device lucistack \
    --sample-rate 100000 \
    --op-time 0.2 \
    --output result.json

# 5. Or, run the same module on the simulator.
uv run analogcli run harmonic.apb --device local-simulator --output sim-result.json

An alternative two-step flow saves the entity blob first, which is useful when running many compiles against the same hardware:

uv run analogcli info lucistack --save-entity lucistack.entity
uv run analogcli compile harmonic.ana lucistack.entity --backend LUCIDAC -o harmonic.apb