CLI Reference#

The standalone command is cb. The conda plugin exposes the same parser as conda broker.

Manage long-running conda-adjacent services.

usage: cb [-h] [--runtime-dir RUNTIME_DIR] [--log-dir LOG_DIR] [--json]
          {start,stop,restart,status,list,endpoint,wait,logs,enable,disable,events,doctor,dev} ...

Positional Arguments#

subcmd: Possible choices: start, stop, restart, status, list, endpoint, wait, logs, enable, disable, events, doctor, dev

Named Arguments#

--runtime-dir

Override the conda-broker runtime directory.

--log-dir

Override the conda-broker log directory.

--json

Emit machine-readable JSON.

Default: False

Sub-commands#

start#

Start the broker or selected services.

cb start [-h] [--runtime-dir RUNTIME_DIR] [--log-dir LOG_DIR] [--json]
         [--timeout TIMEOUT]
         [services ...]

Positional Arguments#

services: Services to start. Omit to start the broker and services enabled for broker startup.

Named Arguments#

--runtime-dir

Override the conda-broker runtime directory.

--log-dir

Override the conda-broker log directory.

--json

Emit machine-readable JSON.

--timeout

Seconds to wait for broker startup.

Default: 5.0

stop#

Stop services or the broker.

cb stop [-h] [--runtime-dir RUNTIME_DIR] [--log-dir LOG_DIR] [--json]
        [services ...]

Positional Arguments#

services: Services to stop. Omit to stop all services and the broker.

Named Arguments#

--runtime-dir: Override the conda-broker runtime directory.
--log-dir: Override the conda-broker log directory.
--json: Emit machine-readable JSON.

restart#

Restart services or the broker.

cb restart [-h] [--runtime-dir RUNTIME_DIR] [--log-dir LOG_DIR] [--json]
           [--timeout TIMEOUT]
           [services ...]

Positional Arguments#

services: Services to restart.

Named Arguments#

--runtime-dir

Override the conda-broker runtime directory.

--log-dir

Override the conda-broker log directory.

--json

Emit machine-readable JSON.

--timeout

Seconds to wait for broker startup.

Default: 5.0

status#

Show broker and service status.

cb status [-h] [--runtime-dir RUNTIME_DIR] [--log-dir LOG_DIR] [--json]
          [service]

Positional Arguments#

service

Named Arguments#

--runtime-dir: Override the conda-broker runtime directory.
--log-dir: Override the conda-broker log directory.
--json: Emit machine-readable JSON.

list#

List discovered services.

cb list [-h] [--runtime-dir RUNTIME_DIR] [--log-dir LOG_DIR] [--json]

Named Arguments#

--runtime-dir: Override the conda-broker runtime directory.
--log-dir: Override the conda-broker log directory.
--json: Emit machine-readable JSON.

endpoint#

Show service endpoints.

cb endpoint [-h] [--runtime-dir RUNTIME_DIR] [--log-dir LOG_DIR] [--json]
            service [endpoint]

Positional Arguments#

service
endpoint: Default: 'default'

Named Arguments#

--runtime-dir: Override the conda-broker runtime directory.
--log-dir: Override the conda-broker log directory.
--json: Emit machine-readable JSON.

wait#

Wait for a service to become ready.

cb wait [-h] [--runtime-dir RUNTIME_DIR] [--log-dir LOG_DIR] [--json]
        [--timeout TIMEOUT] [--start]
        service

Positional Arguments#

service

Named Arguments#

--runtime-dir

Override the conda-broker runtime directory.

--log-dir

Override the conda-broker log directory.

--json

Emit machine-readable JSON.

--timeout

Seconds to wait for service readiness.

Default: 30.0

--start

Start the broker and service before waiting.

Default: False

logs#

Show service logs.

cb logs [-h] [--runtime-dir RUNTIME_DIR] [--log-dir LOG_DIR] [--json]
        [--lines LINES] [--previous] [--follow]
        service

Positional Arguments#

service

Named Arguments#

--runtime-dir: Override the conda-broker runtime directory.
--log-dir: Override the conda-broker log directory.
--json: Emit machine-readable JSON.
--lines: Default: 50
--previous: Default: False
--follow, -f: Default: False

enable#

Enable services on broker start.

cb enable [-h] [--runtime-dir RUNTIME_DIR] [--log-dir LOG_DIR] [--json]
          [--start]
          services [services ...]

Positional Arguments#

services

Named Arguments#

--runtime-dir: Override the conda-broker runtime directory.
--log-dir: Override the conda-broker log directory.
--json: Emit machine-readable JSON.
--start: Default: False

disable#

Disable services on broker start.

cb disable [-h] [--runtime-dir RUNTIME_DIR] [--log-dir LOG_DIR] [--json]
           [--stop]
           services [services ...]

Positional Arguments#

services

Named Arguments#

--runtime-dir: Override the conda-broker runtime directory.
--log-dir: Override the conda-broker log directory.
--json: Emit machine-readable JSON.
--stop: Default: False

events#

Show broker events.

cb events [-h] [--runtime-dir RUNTIME_DIR] [--log-dir LOG_DIR] [--json]
          [--lines LINES] [--follow]

Named Arguments#

--runtime-dir: Override the conda-broker runtime directory.
--log-dir: Override the conda-broker log directory.
--json: Emit machine-readable JSON.
--lines: Default: 50
--follow, -f: Default: False

doctor#

Check conda-broker setup.

cb doctor [-h] [--runtime-dir RUNTIME_DIR] [--log-dir LOG_DIR] [--json]

Named Arguments#

--runtime-dir: Override the conda-broker runtime directory.
--log-dir: Override the conda-broker log directory.
--json: Emit machine-readable JSON.

dev#

Validate and exercise provider service definitions.

cb dev [-h] [--runtime-dir RUNTIME_DIR] [--log-dir LOG_DIR] [--json]
       {validate,run,test,report} ...

Positional Arguments#

devcmd: Possible choices: validate, run, test, report

Named Arguments#

--runtime-dir: Override the conda-broker runtime directory.
--log-dir: Override the conda-broker log directory.
--json: Emit machine-readable JSON.

Sub-commands#

validate#

Validate one service spec.

cb dev validate [-h] [--runtime-dir RUNTIME_DIR] [--log-dir LOG_DIR] [--json]
                service

Positional Arguments#

service

Named Arguments#

--runtime-dir: Override the conda-broker runtime directory.
--log-dir: Override the conda-broker log directory.
--json: Emit machine-readable JSON.

run#

Run one service in an isolated workspace.

cb dev run [-h] [--runtime-dir RUNTIME_DIR] [--log-dir LOG_DIR] [--json]
           [--duration DURATION] [--timeout TIMEOUT] [--keep]
           service

Positional Arguments#

service

Named Arguments#

--runtime-dir

Override the conda-broker runtime directory.

--log-dir

Override the conda-broker log directory.

--json

Emit machine-readable JSON.

--duration

Seconds to observe the running service.

Default: 3.0

--timeout

Seconds to wait for each lifecycle transition.

Default: 5.0

--keep

Keep the temporary runtime/log workspace.

Default: False

test#

Run a conformance scenario.

cb dev test [-h] [--runtime-dir RUNTIME_DIR] [--log-dir LOG_DIR] [--json]
            [--scenario {start-stop,health,crash}] [--timeout TIMEOUT]
            [--keep]
            service

Positional Arguments#

service

Named Arguments#

--runtime-dir

Override the conda-broker runtime directory.

--log-dir

Override the conda-broker log directory.

--json

Emit machine-readable JSON.

--scenario

Possible choices: start-stop, health, crash

Scenario to run.

Default: 'start-stop'

--timeout

Seconds to wait for each lifecycle transition.

Default: 5.0

--keep

Keep the temporary runtime/log workspace.

Default: False

report#

Run the full conformance report.

cb dev report [-h] [--runtime-dir RUNTIME_DIR] [--log-dir LOG_DIR] [--json]
              [--timeout TIMEOUT] [--keep]
              service

Positional Arguments#

service

Named Arguments#

--runtime-dir

Override the conda-broker runtime directory.

--log-dir

Override the conda-broker log directory.

--json

Emit machine-readable JSON.

--timeout

Seconds to wait for each lifecycle transition.

Default: 5.0

--keep

Keep temporary runtime/log workspaces.

Default: False