Command-Line Interface#

Full reference for the CLI:

blueapi#

blueapi [OPTIONS] COMMAND [ARGS]...

Options

--version#

Show the version and exit.

-c, --config <config>#

Path to configuration YAML file

controller#

Client utility for controlling and introspecting the worker

blueapi controller [OPTIONS] COMMAND [ARGS]...

Options

-o, --output <output>#
Options:

json | full | compact

abort#

Abort the execution of the current task, marking any ongoing runs as failed, with optional reason

blueapi controller abort [OPTIONS] [REASON]

Arguments

REASON#

Optional argument

devices#

Get a list of devices available for the worker to use

blueapi controller devices [OPTIONS]

env#

Inspect or restart the environment

blueapi controller env [OPTIONS]

Options

-r, --reload#

Reload the current environment

-t, --timeout <timeout>#

Timeout to wait for reload in seconds, defaults to 10

listen#

Listen to events output by blueapi

blueapi controller listen [OPTIONS]

pause#

Pause the execution of the current task

blueapi controller pause [OPTIONS]

Options

--defer#

Defer the pause until the next checkpoint

plans#

Get a list of plans available for the worker to use

blueapi controller plans [OPTIONS]

resume#

Resume the execution of the current task

blueapi controller resume [OPTIONS]

run#

Run a plan with parameters

blueapi controller run [OPTIONS] NAME [PARAMETERS]

Options

-t, --timeout <timeout>#

Timeout for the plan in seconds. None hangs forever

Arguments

NAME#

Required argument

PARAMETERS#

Optional argument

state#

Print the current state of the worker

blueapi controller state [OPTIONS]

stop#

Stop the execution of the current task, marking as ongoing runs as success

blueapi controller stop [OPTIONS]

login#

blueapi login [OPTIONS]

logout#

blueapi logout [OPTIONS]

schema#

Only import the service functions when starting the service or generating the schema, not the controller as a new FastAPI app will be started each time.

blueapi schema [OPTIONS]

Options

-o, --output <output>#

Path to file to save the schema

-u, --update#

[Development only] update the schema in the documentation

serve#

Run a worker that accepts plans to run

blueapi serve [OPTIONS]

setup-scratch#

blueapi setup-scratch [OPTIONS]