Skip to content

Latest commit

 

History

History
2121 lines (1372 loc) · 61.1 KB

cli.md

File metadata and controls

2121 lines (1372 loc) · 61.1 KB

The compose-api command line

compose-api drives the compose-api service from a terminal or a script: sign up or in through Auth0 in your browser, keep the session in your operating system's credential store, submit simulations, wait for them, fetch their results, and inspect what the service has registered. It covers every operation in the API (a test fails if an operation is added without a command). How it is built and why: plan-cli.md.

Signing in identifies you to the API. It does not make your simulations private: anyone with a simulation's numeric ID can read its status and results (see Authentication). Roles are labels on your identity, not access controls on simulations.

Install

$ pip install 'compose-api-client[cli]'      # or: uv tool install 'compose-api-client[cli]'
$ compose-api --help

The base package (pip install compose-api-client) is the Python client alone: httpx, attrs and python-dateutil, no server dependencies. The [auth] extra adds the Auth0 / keyring session layer, and [cli] includes [auth] plus the terminal UI. In this repository, uv run compose-api ... works with no install.

Connect and Profiles

Setting Option Environment Default
Profile --profile COMPOSE_API_CLI_PROFILE production
Service --url COMPOSE_API_URL the selected profile's api_base_url
HTTP timeout --timeout COMPOSE_API_TIMEOUT 300 s (downloads; other requests cap at 60 s)
Output -o/--output auto|table|json COMPOSE_API_OUTPUT auto: a table on a terminal, JSON when piped
Automation token — (env-only) COMPOSE_API_TOKEN none (uses stored session, else anonymous)

Global options go before the command: compose-api -o json status 4192. Results go to stdout; progress lines and errors go to stderr, so compose-api -o json ... | jq always sees clean JSON.

A profile says which API to call and how to sign in to it. Two are built in:

Profile API Auth0 audience Client ID
production (default) https://compose.cam.uchc.edu https://api.compose.cam.uchc.edu 1FV43fysEjhTrYYRNaMEGvCteu4g2ay4
local https://api.compose-api-local https://api.compose.local Fp3QmULWNIhdutlBRVFm2HjPGapqdnKV

Both use the tenant dev-bu7yo7484tyxu6a1.us.auth0.com, the database connection Username-Password-Authentication, the Google connection google-oauth2 and callback port 8400. The client IDs belong to public native applications: they are identifiers, not secrets, and there is no client secret anywhere in the CLI.

Choose a profile with --profile NAME or COMPOSE_API_CLI_PROFILE. Each setting is then taken from its environment variable, else from [profiles.<name>] in config.toml (under your user configuration directory), else from the built-in value. compose-api config show prints every effective value and where it came from.

Setting Environment variable Meaning
api_base_url COMPOSE_API_CLI_API_BASE_URL The API origin. https only, except a loopback host (http://localhost:8000). No path, query or credentials.
auth0_domain COMPOSE_API_CLI_AUTH0_DOMAIN The tenant's bare host. The issuer is derived from it.
auth0_audience COMPOSE_API_CLI_AUTH0_AUDIENCE The API identifier, exactly as the server's AUTH0_AUDIENCE. It is not the URL you call.
auth0_client_id COMPOSE_API_CLI_AUTH0_CLIENT_ID The native application's public client ID.
database_connection COMPOSE_API_CLI_DATABASE_CONNECTION Optional: steers --provider email to this connection.
google_connection COMPOSE_API_CLI_GOOGLE_CONNECTION Needed for --provider google in the browser.
callback_port COMPOSE_API_CLI_CALLBACK_PORT The registered loopback callback port, http://127.0.0.1:<port>/callback. Default 8400.
ca_bundle COMPOSE_API_CLI_CA_BUNDLE Absolute path to extra CA certificates (PEM) for an API with a private CA.

Sign up and sign in

Passwords, MFA, email verification and Google consent all happen on Auth0's pages in your own browser. The CLI never asks for a password, and never accepts a password or --token flag on the command line.

compose-api auth signup                     # create an email-and-password account
compose-api auth signup --provider google   # first sign-in with Google creates the account
compose-api auth login                      # returning user: choose email or Google on the page
compose-api auth login --provider google
compose-api auth login --method device      # sign in on another device (SSH, containers)
compose-api auth status                     # what is stored locally; contacts nothing
compose-api auth status --verify            # renews if needed and asks GET /auth/me to confirm the identity
compose-api auth logout                     # revokes the refresh token with Auth0, then erases the session
compose-api auth logout --local-only

--method chooses how a sign-in reaches you: auto (the default) picks from the environment: the device code over SSH (SSH_CONNECTION), on a headless host or in a GitHub Codespace, and the browser otherwise. Over SSH or without a display, a recognized VS Code bin/helpers/browser.sh or browser.cmd helper, or WSL's wslview, still gets the browser, since they forward the callback port. VS Code or WSL environment markers alone do not qualify: a text browser, an unknown command or a fallback list in $BROWSER gets the device code. An unrecognized helper can still be chosen explicitly with --method browser. A Codespace still gets the device code, because one opened in a web browser cannot receive the callback. Whenever auto picks anything but your desktop's browser, the command says why and how to choose another way. browser opens the system browser, or $BROWSER without a display. A text browser there (w3m, lynx, links, elinks, www-browser) would take over the terminal, so it counts as none and the command says to use url or device. url prints the sign-in link instead of opening anything; device is RFC 8628, for signing in on another device. The same option works with --ephemeral-auth before any command.

The session is one record in your operating system's credential store (macOS Keychain, Linux Secret Service or Windows Credential Manager), under compose-api.cli.v1.<digest>. Plaintext and unknown keyring backends are refused; there is no file fallback. On hosts without a credential store, use --ephemeral-auth before the command (for example compose-api --ephemeral-auth --method device simulators list), which signs in for a single command in memory without requesting a refresh token.

The browser flow listens on http://127.0.0.1:8400/callback, the only callback the tenant's applications register, so COMPOSE_API_CLI_CALLBACK_PORT cannot move it. If port 8400 is already in use, sign-in stops before the browser opens; over SSH, ssh -L 8400:127.0.0.1:8400 forwards the callback to your own computer, which makes --method url work there.

For CI and non-interactive automation, set COMPOSE_API_TOKEN in the environment. When set, it takes precedence over a stored session for the active profile (printing a one-line notice to stderr), is never renewed or printed, and is still bound by the destination guard (_DestinationGuard), redirect refusal (follow_redirects=False) and environment isolation (trust_env=False). If --url is overridden to an origin different from the profile's api_base_url, neither a stored session nor COMPOSE_API_TOKEN is sent to it.

A run, start to finish

$ compose-api run experiment.omex --simulator viva-pde-particle --wait --download out/ --extract
submitted simulation 4195
    0s simulation 4195: submitting
    5s simulation 4195: running (slurm 4137519)
   31s simulation 4195: completed (slurm 4137519)
{ "simulation_id": 4195, "status": "completed", ..., "files": ["out/results_2026-10-07#08-24-19.pber"] }

Or in steps:

$ compose-api run experiment.omex --simulator viva-pde-particle     # prints simulation_database_id
$ compose-api status 4195                                            # "submitting" until the SLURM job exists
$ compose-api wait 4195
$ compose-api results 4195 --extract out/

Once signed in (compose-api auth login), every command sends the profile's session; without one, commands call the API anonymously, as it allows. Neither ever starts a sign-in on its own:

compose-api simulations list                               # with the stored session, or anonymously
compose-api --ephemeral-auth run experiment.omex           # sign in for this one command; keep nothing
  • Simulation ids. A simulation id is what run prints (simulation_database_id), and what status, wait, results, events, trace and datasets list --sim take. To find one later:

    $ compose-api simulations list                          # newest first, with status and SLURM job
    $ compose-api simulations list --status running --since 6h
    $ compose-api simulations list --simulator viva-pde-particle --limit 20
    $ compose-api simulations list --label source:biomodels --tag repressilator
    $ compose-api simulations show 4334                     # plus how many events and datasets it recorded

    Runs carry labels, written by the service (source, environment, solver, model, ...), and tags and a description given at submission: compose-api run x.omex --tag demo --tag repressilator --description "...". --label key:value and --tag filter the list; each is repeatable, and all must match.

  • --simulator names a prebuilt simulator image the service is configured with. Without it, the service builds one from the document's dependencies, and build-status <simulator_database_id> follows that build.

  • status takes several ids and asks for them in one call.

  • curated copasi and curated tellurium run an SBML model with those simulators.

  • simulators list, processes list and steps list show what is registered.

  • openapi --diff reports whether this client and the live service disagree on the API.

JSON output

Every command takes --json, which prints JSON instead of a table. It's the same as --output json before the command name, and it overrides that option. The auth commands accept --json without listing it in their help: -o json is the spelling documented for them. JSON is also the default whenever output isn't a terminal, so compose-api simulations list | jq needs neither.

What a run did: events and traces

Every run records events: the service's own (dispatch.submitted, then slurm.<state> on each change), the job script's (job.start, and job.end with the exit code, inside a job span), and, if the simulator is built on process-bigraph 1.8.5 or later, the engine's (run.start, run.end, process.exception, its spans).

$ compose-api events 4195                  # everything recorded so far
$ compose-api events 4195 --follow         # and new ones as they arrive, until the job has finished
$ compose-api events 4195 --level error    # only what went wrong
$ compose-api trace 4195                   # the spans as a tree, each with its own events
$ compose-api trace 4195 --chrome t.json   # a file for ui.perfetto.dev

With --output json, events prints JSON lines, one event per line. The service reads a run's events while it runs and for a few minutes after it ends, so a --follow may print a last few events after the job is done.

What a run produced: datasets

Each file a run leaves in its output/ directory, and its results.zip, is a dataset. The job script records each with its size and sha256 when the run ends. A simulator can announce its own files with an artifact.written event, adding a kind, a name and attributes.

$ compose-api datasets list --sim 4195            # one run's files
$ compose-api datasets list --kind results         # every results file you can read
$ compose-api datasets show <id>
$ compose-api datasets get <id> -O out/            # just that file, not the whole archive

A run's SLURM log is a dataset too (job.out, kind log): compose-api datasets list --sim 4195 --kind log, then datasets get on its id. A dataset is readable by whoever can read its simulation.

Output and exit status

Results go to stdout; progress, prompts and human error lines go to stderr. With --json, an error is also printed to stdout as {"error": {"category": ..., "message": ..., "exit_code": ...}}.

Exit Category Meaning
0 Success; with --wait, the job completed
1 not_found, invalid_request, server_error, api_error, job_failed, uncertain, internal The API answered unsuccessfully (404, 400/422, 500, other), the job ended other than completed, a submission outcome was ambiguous, or the CLI hit an internal bug
2 usage A malformed command line, a removed option (--token), or a file argument that cannot be used
3 authentication No session, an expired one that cannot be renewed, a refused or cancelled sign-in, or credentials the API rejected
4 forbidden The API refused the request for this account (403)
5 network, rate_limited, uncertain Auth0 or the API could not be reached, timed out, is unavailable (502/503/504), or is rate limiting (429)
6 configuration, storage, protocol, interaction A profile, credential-store, protocol or local-browser problem
7 wait_timeout --wait-timeout passed before the job finished
130 Cancelled (Ctrl-C)

So compose-api run x.omex --wait && next-step runs next-step only if the simulation completed.

From Python

The command line is a thin layer over compose_api_client.ext, which applications can use directly:

from compose_api_client.ext import ComposeSession

with ComposeSession() as s:  # https://compose.cam.uchc.edu
    sim, state, files = s.run_and_wait("experiment.omex", simulator="viva-pde-particle", dest="out/", extract=True)

AsyncComposeSession has the same methods as coroutines, and AsyncComposeSession.in_process(app) runs against a FastAPI app in a test with no network.

Command reference

Drive compose-api: submit simulations, wait for them, fetch results, inspect the catalogue.

Usage:

$ compose-api [OPTIONS] COMMAND [ARGS]...

Options:

  • --url TEXT: Service base URL. [env var: COMPOSE_API_URL]
  • --profile TEXT: Profile to use (default: production). [env var: COMPOSE_API_CLI_PROFILE]
  • --timeout FLOAT: HTTP timeout, seconds (downloads use the full value; other requests cap at 60 s). [env var: COMPOSE_API_TIMEOUT; default: 300.0]
  • -o, --output [auto|table|json]: auto: table on a terminal, else json. [env var: COMPOSE_API_OUTPUT; default: auto]
  • -v, --verbose: Log HTTP requests; tracebacks on errors.
  • -q, --quiet: No progress lines.
  • --ephemeral-auth: Sign in for this command only, keeping credentials in memory (for hosts without a credential store).
  • --method [auto|browser|url|device]: How --ephemeral-auth signs in: auto (device over SSH, else browser), browser, url or device. [default: auto]
  • --version: Print this program's version and exit.
  • --install-completion: Install completion for the current shell.
  • --show-completion: Show completion for the current shell, to copy it or customize the installation.
  • --help: Show this message and exit.

Commands:

  • health: Is the service up, and which version.
  • version: The service's version.
  • catalog: The catalog: every registry entry with its...
  • solvers: The solvers SED-ML runs can use: each...
  • run: Submit a simulation.
  • status: Job state of one simulation, or of several...
  • wait: Wait until each simulation finishes; exit...
  • results: Fetch a finished simulation's results...
  • events: A simulation's events: from the API, the...
  • trace: A simulation's spans as a tree, each with...
  • build-status: State of a simulator's container build.
  • openapi: The OpenAPI document: this client's...
  • build-log: The SLURM log of a simulator's newest...
  • simulators: Registered simulator versions.
  • processes: Registered process-bigraph processes.
  • steps: Registered process-bigraph steps.
  • curated: Run an SBML model with a curated simulator.
  • datasets: The files runs produced.
  • simulations: Find simulations and their ids.
  • environments: The environments documents run in, and the...
  • sedml: Run SED-ML archives on several solvers and...
  • comparisons: A SED-ML task's runs on several solvers,...
  • biomodels: EBI BioModels: search, describe, download,...
  • biosimulations: biosimulations.org projects: search,...
  • suites: Regression and reproducibility suites of...
  • auth: Sign up, sign in, check or end a session.
  • config: Inspect the CLI configuration.
  • favorites: Your stars on simulations, comparisons and...

compose-api health

Is the service up, and which version.

Usage:

$ compose-api health [OPTIONS]

Options:

  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api version

The service's version.

Usage:

$ compose-api version [OPTIONS]

Options:

  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api catalog

The catalog: every registry entry with its curation level, and the environments that provide its classes.

Discovery and trust, not runnability: most listed entries are in no environment (docs/plan-sedml.md).

Usage:

$ compose-api catalog [OPTIONS]

Options:

  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api solvers

The solvers SED-ML runs can use: each one's class, environment, KiSAO algorithms (default first).

Usage:

$ compose-api solvers [OPTIONS]

Options:

  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api run

Submit a simulation. Prints its ids; with --wait, its final state (and the files, with --download).

Usage:

$ compose-api run [OPTIONS] DOCUMENT

Arguments:

  • DOCUMENT: The .omex (or .pbg) to run. [required]

Options:

  • --simulator TEXT: A prebuilt simulator image by name (the older form of --environment).
  • --environment TEXT: The environment to run in (environments list); omitted: inferred from the document's classes.
  • --interval FLOAT: Simulation interval passed to the runner. [default: 1.0]
  • --batch / --no-batch: Submit as a batch job (smaller partition, 1 CPU). [default: no-batch]
  • -t, --tag TEXT: A tag to find the run by later (repeatable).
  • --description TEXT: What the run is for.
  • --environment-version INTEGER RANGE: The version of the environment to run in (registry_env@3 is 3); omitted: its default. [x>=1]
  • --visibility [private|public]: private (the default signed in: you and admins) or public (anyone); anonymous runs are public.
  • -w, --wait: Wait for the job to finish; exit 1 unless it completed.
  • -d, --download PATH: With --wait: save the results archive into this directory.
  • --extract / --no-extract: With --download: unpack the archive instead of saving the zip. [default: no-extract]
  • --poll FLOAT: Seconds between status checks. [default: 5.0]
  • --wait-timeout FLOAT: Give up waiting after this many seconds (exit 5).
  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api status

Job state of one simulation, or of several in one call. "submitting" means no SLURM job yet.

Usage:

$ compose-api status [OPTIONS] SIMULATION_IDS...

Arguments:

  • SIMULATION_IDS...: One or more simulation ids. [required]

Options:

  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api wait

Wait until each simulation finishes; exit 1 unless all completed.

Usage:

$ compose-api wait [OPTIONS] SIMULATION_IDS...

Arguments:

  • SIMULATION_IDS...: One or more simulation ids. [required]

Options:

  • --poll FLOAT: Seconds between status checks. [default: 5.0]
  • --wait-timeout FLOAT: Give up waiting after this many seconds (exit 5).
  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api results

Fetch a finished simulation's results archive.

Usage:

$ compose-api results [OPTIONS] SIMULATION_ID

Arguments:

  • SIMULATION_ID: The simulation id. [required]

Options:

  • -O, --out PATH: Write the zip here (a file, or a directory).
  • --extract PATH: Unpack the archive into this directory instead.
  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api events

A simulation's events: from the API, the job script and the simulator's engine. JSON output is JSON lines.

Usage:

$ compose-api events [OPTIONS] SIMULATION_ID

Arguments:

  • SIMULATION_ID: The simulation id. [required]

Options:

  • -f, --follow: Keep printing new events until the job has finished.
  • --level TEXT: Only events at this level: debug, info, warning, error.
  • --event TEXT: Only events with this name, e.g. job.end.
  • --poll FLOAT: Seconds between status checks. [default: 5.0]
  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api trace

A simulation's spans as a tree, each with its own events; or, with --chrome, a file for Perfetto.

Usage:

$ compose-api trace [OPTIONS] SIMULATION_ID

Arguments:

  • SIMULATION_ID: The simulation id. [required]

Options:

  • --chrome PATH: Save the trace as a Chrome Trace Event file instead; open it in ui.perfetto.dev.
  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api build-status

State of a simulator's container build.

Usage:

$ compose-api build-status [OPTIONS] SIMULATOR_ID

Arguments:

  • SIMULATOR_ID: The simulator id (from a submission's simulator_database_id). [required]

Options:

  • -w, --wait: Wait for the job to finish; exit 1 unless it completed.
  • --poll FLOAT: Seconds between status checks. [default: 5.0]
  • --wait-timeout FLOAT: Give up waiting after this many seconds (exit 5).
  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api openapi

The OpenAPI document: this client's (default) or the service's; --diff reports skew between them.

Usage:

$ compose-api openapi [OPTIONS]

Options:

  • --server / --no-server: Fetch the live service's /openapi.json instead. [default: no-server]
  • --diff / --no-diff: Compare this client's operations with the live service's; exit 1 on skew. [default: no-diff]
  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api build-log

The SLURM log of a simulator's newest container build.

Usage:

$ compose-api build-log [OPTIONS] SIMULATOR_ID

Arguments:

  • SIMULATOR_ID: The simulator id (a run's simulator_id). [required]

Options:

  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api simulators

Registered simulator versions.

Usage:

$ compose-api simulators [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • list: Simulator versions: id, definition hash,...
  • history: Every simulator that is an environment...
  • show: One simulator: its container definition,...
  • images: Whether a simulator's image is built: its...
  • build: Make a simulator's image available: pulled...

compose-api simulators list

Simulator versions: id, definition hash, base image, creation time.

Usage:

$ compose-api simulators list [OPTIONS]

Options:

  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api simulators history

Every simulator that is an environment version or that runs you can read used, newest first: the versions it is (none for one from before versions), and how many runs used it and when.

Usage:

$ compose-api simulators history [OPTIONS]

Options:

  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api simulators show

One simulator: its container definition, the versions it is, and the runs that used it (simulations list --simulator-id lists them).

Usage:

$ compose-api simulators show [OPTIONS] SIMULATOR_ID

Arguments:

  • SIMULATOR_ID: The simulator's id. [required]

Options:

  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api simulators images

Whether a simulator's image is built: its image records and its newest build run.

Usage:

$ compose-api simulators images [OPTIONS] SIMULATOR_ID

Arguments:

  • SIMULATOR_ID: The simulator's id. [required]

Options:

  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api simulators build

Make a simulator's image available: pulled or built unless it is, joining a build under way.

Usage:

$ compose-api simulators build [OPTIONS] SIMULATOR_ID

Arguments:

  • SIMULATOR_ID: The simulator's id. [required]

Options:

  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api processes

Registered process-bigraph processes.

Usage:

$ compose-api processes [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • list: Registered processes.

compose-api processes list

Registered processes.

Usage:

$ compose-api processes list [OPTIONS]

Options:

  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api steps

Registered process-bigraph steps.

Usage:

$ compose-api steps [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • list: Registered steps.

compose-api steps list

Registered steps.

Usage:

$ compose-api steps list [OPTIONS]

Options:

  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api curated

Run an SBML model with a curated simulator.

Usage:

$ compose-api curated [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • copasi: Run an SBML model with COPASI.
  • tellurium: Run an SBML model with Tellurium.

compose-api curated copasi

Run an SBML model with COPASI.

Usage:

$ compose-api curated copasi [OPTIONS] SBML

Arguments:

  • SBML: The SBML model. [required]

Options:

  • --start FLOAT: Start time. [required]
  • --duration FLOAT: Duration. [required]
  • --points INTEGER: Number of output points. [required]
  • --visibility [private|public]: private (the default signed in: you and admins) or public (anyone); anonymous runs are public.
  • -w, --wait: Wait for the job to finish; exit 1 unless it completed.
  • -d, --download PATH: With --wait: save the results archive into this directory.
  • --extract / --no-extract: With --download: unpack the archive instead of saving the zip. [default: no-extract]
  • --poll FLOAT: Seconds between status checks. [default: 5.0]
  • --wait-timeout FLOAT: Give up waiting after this many seconds (exit 5).
  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api curated tellurium

Run an SBML model with Tellurium.

Usage:

$ compose-api curated tellurium [OPTIONS] SBML

Arguments:

  • SBML: The SBML model. [required]

Options:

  • --start FLOAT: Start time. [required]
  • --end FLOAT: End time. [required]
  • --points INTEGER: Number of output points. [required]
  • --visibility [private|public]: private (the default signed in: you and admins) or public (anyone); anonymous runs are public.
  • -w, --wait: Wait for the job to finish; exit 1 unless it completed.
  • -d, --download PATH: With --wait: save the results archive into this directory.
  • --extract / --no-extract: With --download: unpack the archive instead of saving the zip. [default: no-extract]
  • --poll FLOAT: Seconds between status checks. [default: 5.0]
  • --wait-timeout FLOAT: Give up waiting after this many seconds (exit 5).
  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api datasets

The files runs produced.

Usage:

$ compose-api datasets [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • list: The files runs produced: one simulation's,...
  • show: Everything recorded about one dataset.
  • get: Download a dataset's file.
  • file: Download one file from inside a directory...

compose-api datasets list

The files runs produced: one simulation's, or every one you may read, newest simulations first.

Usage:

$ compose-api datasets list [OPTIONS]

Options:

  • --sim INTEGER: Only this simulation's datasets.
  • --kind TEXT: Only this kind: results, table, figure, archive, ...
  • --match TEXT: Only paths or names containing this.
  • --missing / --no-missing: List datasets whose file is gone instead. [default: no-missing]
  • --limit INTEGER: At most this many. [default: 100]
  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api datasets show

Everything recorded about one dataset.

Usage:

$ compose-api datasets show [OPTIONS] DATASET_ID

Arguments:

  • DATASET_ID: The dataset id. [required]

Options:

  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api datasets get

Download a dataset's file.

Usage:

$ compose-api datasets get [OPTIONS] DATASET_ID

Arguments:

  • DATASET_ID: The dataset id. [required]

Options:

  • -O, --out PATH: Write it here (a file, or a directory). Default: here.
  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api datasets file

Download one file from inside a directory dataset.

Usage:

$ compose-api datasets file [OPTIONS] DATASET_ID SUBPATH

Arguments:

  • DATASET_ID: The dataset id (a directory dataset: a results bundle or zarr). [required]
  • SUBPATH: The file inside it, e.g. .zattrs or u/0.0. [required]

Options:

  • -O, --out PATH: Write it here (a file, or a directory). Default: here.
  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api simulations

Find simulations and their ids.

Usage:

$ compose-api simulations [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • list: Simulations you can read, newest first,...
  • show: One simulation: its simulator, its latest...
  • cancel: Cancel a run (sign in first: `compose-api...
  • visibility: Make a run you own public or private.

compose-api simulations list

Simulations you can read, newest first, each with its latest SLURM job. The ids are what every other command takes.

Usage:

$ compose-api simulations list [OPTIONS]

Options:

  • --status TEXT: Only this state: submitting, running, completed, failed, timeout, ...
  • --simulator TEXT: Only this prebuilt simulator (name), or a container-definition hash prefix.
  • --simulator-id INTEGER: Only those that used this simulator (simulators history lists them).
  • --environment TEXT: Only those that ran in a version of this environment.
  • --environment-version TEXT: Only those that ran in this version, name@number, e.g. registry_env@5.
  • --since TEXT: Only those created since: 30m, 6h, 2d, 1w, or an ISO time.
  • --label TEXT: Only those with this label, key:value, e.g. source:biomodels (repeatable, all must match).
  • --tag TEXT: Only those with this tag (repeatable, all must match).
  • --mine: Only those you submitted (needs compose-api login).
  • --favorite: Only those you starred (compose-api favorites add).
  • --limit INTEGER: At most this many. [default: 50]
  • --offset INTEGER: Skip this many (for the next page). [default: 0]
  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api simulations show

One simulation: its simulator, its latest SLURM job, and how many events and datasets its run recorded.

Usage:

$ compose-api simulations show [OPTIONS] SIMULATION_ID

Arguments:

  • SIMULATION_ID: The simulation id. [required]

Options:

  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api simulations cancel

Cancel a run (sign in first: compose-api auth login). A queued run is withdrawn at once; a run SLURM has is cancelled there, and its status reads cancelled once the service sees that.

Usage:

$ compose-api simulations cancel [OPTIONS] SIMULATION_ID

Arguments:

  • SIMULATION_ID: The simulation id. [required]

Options:

  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api simulations visibility

Make a run you own public or private. The other runs of every comparison it is in change with it.

Usage:

$ compose-api simulations visibility [OPTIONS] SIMULATION_ID VISIBILITY:{private|public}

Arguments:

  • SIMULATION_ID: The simulation id. [required]
  • VISIBILITY:{private|public}: public or private. [required]

Options:

  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api environments

The environments documents run in, and the process interfaces each provides.

Usage:

$ compose-api environments [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • list: Environments: the --simulator to run in...
  • manifest: An environment's interface manifest: its...
  • headers: An environment's interfaces as .pblang...
  • images: Whether an environment's current image is...
  • build: Make an environment's current image...
  • versions: An environment's versions, newest first,...
  • version: One version: what it was made from, its...
  • export: Write the files that recreate a version...
  • compliance: Where each entry of a version stands...
  • create: Make a new version (or answer the existing...
  • default: Make a ready version the one runs get when...
  • inspect: Read a version's image back again: what it...
  • retire: Retire a version: it refuses new runs; its...

compose-api environments list

Environments: the --simulator to run in each, its image, and whether its manifest is current.

Usage:

$ compose-api environments list [OPTIONS]

Options:

  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api environments manifest

An environment's interface manifest: its steps and processes, their config schemas and ports.

--output json prints the manifest itself (pbg-interfaces/1), which other tools read as it is.

Usage:

$ compose-api environments manifest [OPTIONS] NAME

Arguments:

  • NAME: The environment, e.g. registry_env. [required]

Options:

  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api environments headers

An environment's interfaces as .pblang header files: what a composite imports (import module.{Name};).

Prints every module's file, or writes them into --out; --output json prints them with each class's declaration.

Usage:

$ compose-api environments headers [OPTIONS] NAME

Arguments:

  • NAME: The environment, e.g. registry_env. [required]

Options:

  • -o, --out PATH: Write one <module>.pbl per module into this directory.
  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api environments images

Whether an environment's current image is built: its image records and its newest build run.

Usage:

$ compose-api environments images [OPTIONS] NAME

Arguments:

  • NAME: The environment, e.g. registry_env. [required]

Options:

  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api environments build

Make an environment's current image available: pulled or built unless it is, joining a build under way.

Returns at once; environments images follows the build.

Usage:

$ compose-api environments build [OPTIONS] NAME

Arguments:

  • NAME: The environment, e.g. registry_env. [required]

Options:

  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api environments versions

An environment's versions, newest first, and the default a run that names none gets.

Usage:

$ compose-api environments versions [OPTIONS] NAME

Arguments:

  • NAME: The environment, e.g. registry_env. [required]

Options:

  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api environments version

One version: what it was made from, its lock, and what it installed and provides. With --against, the packages added, removed or at another version since that one, as their images installed them.

Usage:

$ compose-api environments version [OPTIONS] NAME NUMBER

Arguments:

  • NAME: The environment, e.g. registry_env. [required]
  • NUMBER: The version's number (registry_env@3 is 3). [required]

Options:

  • --against INTEGER: Another version's number: list how this one's packages differ from it.
  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api environments export

Write the files that recreate a version locally: a composed version's pixi.toml and pixi.lock (then pixi install --frozen) or, when it needs nothing from conda, its pyproject.toml and uv.lock (then uv sync); a shared one's uv lock as requirements.txt (then uv pip install -r). Both describe CPython on Linux x86-64, the platform the image runs.

Usage:

$ compose-api environments export [OPTIONS] NAME NUMBER

Arguments:

  • NAME: The environment, e.g. registry_env. [required]
  • NUMBER: The version's number (registry_env@3 is 3). [required]

Options:

  • -o, --out PATH: Directory to write the files into. [default: .]
  • --format TEXT: pixi (pixi.toml, pixi.lock), uv (pyproject.toml, uv.lock; without conda) or requirements; pixi by default for a composed version.
  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api environments compliance

Where each entry of a version stands there: tested when its compliance cases passed in it, and the components a generic check refuses (a step whose results accumulate, say).

Usage:

$ compose-api environments compliance [OPTIONS] NAME NUMBER

Arguments:

  • NAME: The environment, e.g. registry_env. [required]
  • NUMBER: The version's number (registry_env@3 is 3). [required]

Options:

  • --run: Run the cases again first (needs the environment administrator role).
  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api environments create

Make a new version (or answer the existing one with the same definition). Its image builds in the background (environments versions shows it ready); it does not become the default. Needs the environment administrator role.

Usage:

$ compose-api environments create [OPTIONS] NAME

Arguments:

  • NAME: The environment, e.g. registry_env. [required]

Options:

  • --resolved-at [%Y-%m-%d|%Y-%m-%dT%H:%M:%S|%Y-%m-%d %H:%M:%S]: A shared environment: resolve as of this time (UTC); default now.
  • --image TEXT: A prebuilt environment: its image, by digest.
  • --note TEXT: Why this version exists.
  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api environments default

Make a ready version the one runs get when they name none. Needs the environment administrator role.

Usage:

$ compose-api environments default [OPTIONS] NAME NUMBER

Arguments:

  • NAME: The environment, e.g. registry_env. [required]
  • NUMBER: The version's number (registry_env@3 is 3). [required]

Options:

  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api environments inspect

Read a version's image back again: what it installed and the interfaces it provides (in the background; environments version shows them). For a prebuilt image, or a shared one built before builds read images back. Needs the environment administrator role.

Usage:

$ compose-api environments inspect [OPTIONS] NAME NUMBER

Arguments:

  • NAME: The environment, e.g. registry_env. [required]
  • NUMBER: The version's number (registry_env@3 is 3). [required]

Options:

  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api environments retire

Retire a version: it refuses new runs; its images are kept. Needs the environment administrator role.

Usage:

$ compose-api environments retire [OPTIONS] NAME NUMBER

Arguments:

  • NAME: The environment, e.g. registry_env. [required]
  • NUMBER: The version's number (registry_env@3 is 3). [required]

Options:

  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api sedml

Run SED-ML archives on several solvers and compare them.

Usage:

$ compose-api sedml [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • preview: Translate an archive without running it:...
  • run: Run each task once per solver; prints each...

compose-api sedml preview

Translate an archive without running it: its tasks, the solvers that accept each, and the findings.

Usage:

$ compose-api sedml preview [OPTIONS] ARCHIVE

Arguments:

  • ARCHIVE: A COMBINE/OMEX archive with SED-ML and its models. [required]

Options:

  • -s, --solver TEXT: A solver id (repeatable); all when omitted.
  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api sedml run

Run each task once per solver; prints each task's comparison and its runs.

Usage:

$ compose-api sedml run [OPTIONS] ARCHIVE

Arguments:

  • ARCHIVE: A COMBINE/OMEX archive with SED-ML and its models. [required]

Options:

  • -s, --solver TEXT: A solver id (repeatable); all when omitted.
  • --task TEXT: A SED-ML task id (repeatable); all when omitted.
  • -t, --tag TEXT: A tag for every run (repeatable).
  • --description TEXT: What the runs are for.
  • --environment-version TEXT: An environment version to run in: environment@number (registry_env@2) or environment@default (repeatable); an environment not named runs at its default.
  • --visibility [private|public]: private (the default signed in: you and admins) or public (anyone); anonymous runs are public.
  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api comparisons

A SED-ML task's runs on several solvers, and how they compare.

Usage:

$ compose-api comparisons [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • list: Comparisons, newest first.
  • show: One comparison: its runs, and per report...
  • verify: Check a comparison against BioSimulators'...
  • verifications: A comparison's verifications, oldest...
  • series: One report's columns from each run and...

compose-api comparisons list

Comparisons, newest first.

Usage:

$ compose-api comparisons list [OPTIONS]

Options:

  • --source TEXT: Only this source, e.g. upload:x.omex.
  • --favorite: Only those you starred (compose-api favorites add).
  • --limit INTEGER: At most this many. [default: 25]
  • --offset INTEGER: Skip this many. [default: 0]
  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api comparisons show

One comparison: its runs, and per report the worst data set once every run has finished.

Usage:

$ compose-api comparisons show [OPTIONS] COMPARISON_ID

Arguments:

  • COMPARISON_ID: The comparison id. [required]

Options:

  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api comparisons verify

Check a comparison against BioSimulators' simulators through biosim's /verify (queued; poll with comparisons verifications).

Usage:

$ compose-api comparisons verify [OPTIONS] COMPARISON_ID

Arguments:

  • COMPARISON_ID: The comparison id. [required]

Options:

  • --simulator TEXT: A simulator, name or name:version; repeat. Default: the service's.
  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api comparisons verifications

A comparison's verifications, oldest first: their state, and whether BioSimulators' simulators agree.

Usage:

$ compose-api comparisons verifications [OPTIONS] COMPARISON_ID

Arguments:

  • COMPARISON_ID: The comparison id. [required]

Options:

  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api comparisons series

One report's columns from each run and each reference (JSON; a table lists what is there).

Usage:

$ compose-api comparisons series [OPTIONS] COMPARISON_ID

Arguments:

  • COMPARISON_ID: The comparison id. [required]

Options:

  • --report TEXT: The SED-ML report id. [required]
  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api biomodels

EBI BioModels: search, describe, download, run.

Usage:

$ compose-api biomodels [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • search: Search EBI BioModels (manually curated...
  • show: One BioModels entry: name, curation...
  • get: Download the entry's COMBINE archive.
  • run: Run the entry's SED-ML once per solver;...

compose-api biomodels search

Search EBI BioModels (manually curated models unless --all).

Usage:

$ compose-api biomodels search [OPTIONS] QUERY

Arguments:

  • QUERY: Words to search for. [required]

Options:

  • --limit INTEGER: At most this many. [default: 20]
  • --all: Not only manually curated models.
  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api biomodels show

One BioModels entry: name, curation status, latest revision.

Usage:

$ compose-api biomodels show [OPTIONS] MODEL_ID

Arguments:

  • MODEL_ID: e.g. BIOMD0000000012 [required]

Options:

  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api biomodels get

Download the entry's COMBINE archive.

Usage:

$ compose-api biomodels get [OPTIONS] MODEL_ID

Arguments:

  • MODEL_ID: e.g. BIOMD0000000012 [required]

Options:

  • -O, --out PATH: Write the archive here (a file or a directory).
  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api biomodels run

Run the entry's SED-ML once per solver; prints each task's comparison and its runs.

Usage:

$ compose-api biomodels run [OPTIONS] MODEL_ID

Arguments:

  • MODEL_ID: e.g. BIOMD0000000012 [required]

Options:

  • -s, --solver TEXT: A solver id (repeatable); all when omitted.
  • -t, --tag TEXT: A tag for every run (repeatable).
  • --environment-version TEXT: An environment version to run in: environment@number (registry_env@2) or environment@default (repeatable); an environment not named runs at its default.
  • --visibility [private|public]: private (the default signed in: you and admins) or public (anyone); anonymous runs are public.
  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api biosimulations

biosimulations.org projects: search, describe, download, run.

Usage:

$ compose-api biosimulations [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • search: biosimulations.org projects whose id...
  • show: One project: its run and the simulator...
  • get: Download the project's archive.
  • reference: The project's original results: each...
  • run: Run the project's SED-ML once per solver,...

compose-api biosimulations search

biosimulations.org projects whose id contains the query.

Usage:

$ compose-api biosimulations search [OPTIONS] [QUERY]

Arguments:

  • [QUERY]: Part of a project id.

Options:

  • --limit INTEGER: At most this many. [default: 20]
  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api biosimulations show

One project: its run and the simulator that ran it.

Usage:

$ compose-api biosimulations show [OPTIONS] PROJECT_ID

Arguments:

  • PROJECT_ID: The project id. [required]

Options:

  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api biosimulations get

Download the project's archive.

Usage:

$ compose-api biosimulations get [OPTIONS] PROJECT_ID

Arguments:

  • PROJECT_ID: The project id. [required]

Options:

  • -O, --out PATH: Write the archive here (a file or a directory).
  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api biosimulations reference

The project's original results: each report's labels and number of points (--output json for the values).

Usage:

$ compose-api biosimulations reference [OPTIONS] PROJECT_ID

Arguments:

  • PROJECT_ID: The project id. [required]

Options:

  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api biosimulations run

Run the project's SED-ML once per solver, its original results as the reference.

Usage:

$ compose-api biosimulations run [OPTIONS] PROJECT_ID

Arguments:

  • PROJECT_ID: The project id. [required]

Options:

  • -s, --solver TEXT: A solver id (repeatable); all when omitted.
  • -t, --tag TEXT: A tag for every run (repeatable).
  • --environment-version TEXT: An environment version to run in: environment@number (registry_env@2) or environment@default (repeatable); an environment not named runs at its default.
  • --visibility [private|public]: private (the default signed in: you and admins) or public (anyone); anonymous runs are public.
  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api suites

Regression and reproducibility suites of SED-ML models.

Usage:

$ compose-api suites [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • list: The suites: their sources, solvers and...
  • runs: A suite's runs, newest first.
  • show: One suite run: per source, whether the...
  • run: Run every source of the suite on its...
  • verify: Queue a check against biosim's /verify for...
  • problems: A suite's known problems, oldest first:...
  • mark-problem: Record a known problem: the solver's...
  • edit-problem: Change a known problem's category or reason.
  • clear-problem: Clear a known problem that no longer...

compose-api suites list

The suites: their sources, solvers and accepted baseline run.

Usage:

$ compose-api suites list [OPTIONS]

Options:

  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api suites runs

A suite's runs, newest first.

Usage:

$ compose-api suites runs [OPTIONS] NAME

Arguments:

  • NAME: The suite, e.g. biomodels-ode-sample. [required]

Options:

  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api suites show

One suite run: per source, whether the solvers agree, match references, and drifted from the baseline.

Usage:

$ compose-api suites show [OPTIONS] NAME NUMBER

Arguments:

  • NAME: The suite, e.g. biomodels-ode-sample. [required]
  • NUMBER: The run's number. [required]

Options:

  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api suites run

Run every source of the suite on its solvers; prints the new run's number and the versions it runs in.

Usage:

$ compose-api suites run [OPTIONS] NAME

Arguments:

  • NAME: The suite, e.g. biomodels-ode-sample. [required]

Options:

  • --environment-version TEXT: Required (repeatable): the environment versions the suite runs in, environment@number (registry_env@2), environment@default, or default (every environment at its default). The run records them as numbers. [required]
  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api suites verify

Queue a check against biosim's /verify for a suite run's finished comparisons.

Usage:

$ compose-api suites verify [OPTIONS] NAME NUMBER

Arguments:

  • NAME: The suite, e.g. biomodels-ode-sample. [required]
  • NUMBER: The run's number. [required]

Options:

  • --all: Every finished comparison, not only those that differ or lack agreeing references.
  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api suites problems

A suite's known problems, oldest first: each solver's expected failures, excused in its runs until cleared.

Usage:

$ compose-api suites problems [OPTIONS] NAME

Arguments:

  • NAME: The suite, e.g. biomodels-ode-sample. [required]

Options:

  • --open: Only the open ones.
  • --cleared: Only the cleared ones.
  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api suites mark-problem

Record a known problem: the solver's failure or disagreement on the source is excused until it is cleared. Needs the suite curator role.

Usage:

$ compose-api suites mark-problem [OPTIONS] NAME SOURCE

Arguments:

  • NAME: The suite, e.g. biomodels-ode-sample. [required]
  • SOURCE: The suite's source, e.g. biomodels:BIOMD0000000039. [required]

Options:

  • --category TEXT: What kind of problem, e.g. NONINTEGER_STOICH. [required]
  • --reason TEXT: Why it fails or differs. [required]
  • --solver TEXT: The solver it applies to; omit for a problem of the whole source.
  • --seen-run INTEGER: The suite run it was first seen in.
  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api suites edit-problem

Change a known problem's category or reason. Needs the suite curator role.

Usage:

$ compose-api suites edit-problem [OPTIONS] NAME PROBLEM_ID

Arguments:

  • NAME: The suite, e.g. biomodels-ode-sample. [required]
  • PROBLEM_ID: The problem's id (suites problems). [required]

Options:

  • --category TEXT: A new category.
  • --reason TEXT: A new reason.
  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api suites clear-problem

Clear a known problem that no longer occurs (a suite run lists it as resolved). Needs the suite curator role.

Usage:

$ compose-api suites clear-problem [OPTIONS] NAME PROBLEM_ID

Arguments:

  • NAME: The suite, e.g. biomodels-ode-sample. [required]
  • PROBLEM_ID: The problem's id (suites problems). [required]

Options:

  • --run INTEGER: The suite run that shows it fixed; earlier runs still excuse it. [required]
  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api auth

Sign up, sign in, check or end a session.

Usage:

$ compose-api auth [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • signup: Create an account in the browser, then...
  • login: Sign in in the browser or with a device code.
  • status: Show the stored session without contacting...
  • logout: Revoke the refresh token with Auth0 and...

compose-api auth signup

Create an account in the browser, then sign in.

Usage:

$ compose-api auth signup [OPTIONS]

Options:

  • --provider [email|google]: Identity provider: email or google. With --method device it is advice: the page chooses. [default: email]
  • --method [auto|browser|url|device]: How to sign in: auto (device over SSH, else browser), browser, url (print the link) or device. [default: auto]
  • --help: Show this message and exit.

compose-api auth login

Sign in in the browser or with a device code.

Usage:

$ compose-api auth login [OPTIONS]

Options:

  • --provider [email|google]: Identity provider: email or google. With --method device it is advice: the page chooses.
  • --method [auto|browser|url|device]: How to sign in: auto (device over SSH, else browser), browser, url (print the link) or device. [default: auto]
  • --help: Show this message and exit.

compose-api auth status

Show the stored session without contacting any server, unless --verify is given.

Usage:

$ compose-api auth status [OPTIONS]

Options:

  • --verify: Refresh if needed and confirm the identity with the API.
  • --help: Show this message and exit.

compose-api auth logout

Revoke the refresh token with Auth0 and erase the stored session.

Usage:

$ compose-api auth logout [OPTIONS]

Options:

  • --local-only: Erase the local session without contacting Auth0.
  • --help: Show this message and exit.

compose-api config

Inspect the CLI configuration.

Usage:

$ compose-api config [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • show: Print the effective profile and where each...

compose-api config show

Print the effective profile and where each value came from. Profiles hold no secrets.

Usage:

$ compose-api config show [OPTIONS]

Options:

  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api favorites

Your stars on simulations, comparisons and suite runs (needs compose-api auth login).

Usage:

$ compose-api favorites [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • add: Star a simulation, a comparison or a suite...
  • remove: Unstar it.
  • list: Your stars, newest first.

compose-api favorites add

Star a simulation, a comparison or a suite run. Your stars are yours alone; starring it again changes nothing.

Usage:

$ compose-api favorites add [OPTIONS] KIND:{comparison|simulation|suite_run} REF

Arguments:

  • KIND:{comparison|simulation|suite_run}: simulation, comparison or suite_run. [required]
  • REF: A simulation's or a comparison's id; a suite run as <suite>@<number>, e.g. smoke@22. [required]

Options:

  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api favorites remove

Unstar it.

Usage:

$ compose-api favorites remove [OPTIONS] KIND:{comparison|simulation|suite_run} REF

Arguments:

  • KIND:{comparison|simulation|suite_run}: simulation, comparison or suite_run. [required]
  • REF: A simulation's or a comparison's id; a suite run as <suite>@<number>, e.g. smoke@22. [required]

Options:

  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.

compose-api favorites list

Your stars, newest first. simulations list --favorite and comparisons list --favorite show them in full.

Usage:

$ compose-api favorites list [OPTIONS]

Options:

  • --kind [comparison|simulation|suite_run]: Only this kind: simulation, comparison or suite_run.
  • --json: Print JSON (the same as --output json).
  • --help: Show this message and exit.