Skip to content

cayu cloud

Generated from the released command parser. These commands show help only; operations run when you invoke the command without --help.

Terminal window
usage: cayu cloud [-h] [--api-key-file API_KEY_FILE] [--context CONTEXT]
                  [--evidence-dir EVIDENCE_DIR]
                  [--timeout-seconds TIMEOUT_SECONDS]
                  {login,logout,whoami,applications,context,doctor,init,deploy,deployment,rollback,runtimes,service,env,evidence} ...


Manage Cayu Cloud.


positional arguments:
  {login,logout,whoami,applications,context,doctor,init,deploy,deployment,rollback,runtimes,service,env,evidence}
    login               Sign in through WorkOS.
    logout              Delete the local login.
    whoami              Show the current user and Organization.
    applications        List deployed Agent applications.
    context             Select or inspect a private connection context.
    doctor              Verify authentication and API access.
    init                Generate cayu-cloud.toml.
    deploy              Publish an immutable Agent release.
    deployment          Inspect or operate an immutable release.
    rollback            Select an earlier immutable release.
    runtimes            Inspect retained runtime artifacts.
    service             Operate long-horizon Agent infrastructure.
    env                 Manage Agent environment variables and secrets.
    evidence            Inspect local Cloud command evidence.


options:
  -h, --help            show this help message and exit
  --api-key-file API_KEY_FILE
                        Defaults to context.
  --context CONTEXT     Private Cayu Cloud context JSON.
  --evidence-dir EVIDENCE_DIR
  --timeout-seconds TIMEOUT_SECONDS

cayu cloud login

Section titled “cayu cloud login”
Terminal window
usage: cayu cloud login [-h] [--no-browser]


Sign in to Cayu Cloud through WorkOS in a web browser.


options:
  -h, --help    show this help message and exit
  --no-browser  Print the verification URL and code without opening a browser.

cayu cloud logout

Section titled “cayu cloud logout”
Terminal window
usage: cayu cloud logout [-h]


Delete the local interactive Cayu Cloud login.


options:
  -h, --help  show this help message and exit

cayu cloud whoami

Section titled “cayu cloud whoami”
Terminal window
usage: cayu cloud whoami [-h]


Show the current Cayu Cloud user and Organization.


options:
  -h, --help  show this help message and exit

cayu cloud applications

Section titled “cayu cloud applications”
Terminal window
usage: cayu cloud applications [-h] {list,archive,archive-status} ...


List Agent applications deployed in the selected Cayu Cloud.


positional arguments:
  {list,archive,archive-status}


options:
  -h, --help            show this help message and exit

cayu cloud applications list

Section titled “cayu cloud applications list”
Terminal window
usage: cayu cloud applications list [-h] [--lifecycle {active,archived,all}]


List Agent applications and their selected releases.


options:
  -h, --help            show this help message and exit
  --lifecycle {active,archived,all}
                        Active Agents by default; archived also lists Agents
                        being archived.

cayu cloud applications archive

Section titled “cayu cloud applications archive”
Terminal window
usage: cayu cloud applications archive [-h]
                                       --expected-revision EXPECTED_REVISION
                                       [--idempotency-key IDEMPOTENCY_KEY]
                                       [--no-wait]
                                       [--poll-seconds POLL_SECONDS]
                                       [--wait-seconds WAIT_SECONDS]
                                       application


Archive an Agent: stop its service, schedules and ingress for good and keep
its Releases, configuration, data and history. Requires an organization
administrator login and can't be undone.


positional arguments:
  application           The exact Agent slug.


options:
  -h, --help            show this help message and exit
  --expected-revision EXPECTED_REVISION
                        The Agent revision the decision was made on
                        (`applications archive-status`).
  --idempotency-key IDEMPOTENCY_KEY
                        Defaults to one derived from the revision.
  --no-wait             Return once requested.
  --poll-seconds POLL_SECONDS
  --wait-seconds WAIT_SECONDS

cayu cloud applications archive-status

Section titled “cayu cloud applications archive-status”
Terminal window
usage: cayu cloud applications archive-status [-h] application


Show an Agent's lifecycle, revision and archive progress.


positional arguments:
  application


options:
  -h, --help   show this help message and exit

cayu cloud context

Section titled “cayu cloud context”
Terminal window
usage: cayu cloud context [-h] {use,show,clear} ...


Select or inspect the private Cayu Cloud connection context.


positional arguments:
  {use,show,clear}


options:
  -h, --help        show this help message and exit

cayu cloud context use

Section titled “cayu cloud context use”
Terminal window
usage: cayu cloud context use [-h] context_path


Select a private Cayu Cloud context file for later commands.


positional arguments:
  context_path


options:
  -h, --help    show this help message and exit

cayu cloud context show

Section titled “cayu cloud context show”
Terminal window
usage: cayu cloud context show [-h]


Show the selected context without exposing its API key.


options:
  -h, --help  show this help message and exit

cayu cloud context clear

Section titled “cayu cloud context clear”
Terminal window
usage: cayu cloud context clear [-h]


Forget the selected Cayu Cloud context on this machine.


options:
  -h, --help  show this help message and exit

cayu cloud doctor

Section titled “cayu cloud doctor”
Terminal window
usage: cayu cloud doctor [-h]


Verify authentication and API access to the selected Cayu Cloud.


options:
  -h, --help  show this help message and exit

cayu cloud init

Section titled “cayu cloud init”
Terminal window
usage: cayu cloud init [-h] [--force] [path]


Generate cayu-cloud.toml from a Python Agent project. For a `cayu serve` web
process, also add the cayu server extra and the environment operator auth
target to pyproject.toml when they are missing; an existing auth target is
never replaced.


positional arguments:
  path


options:
  -h, --help  show this help message and exit
  --force     Replace an existing cayu-cloud.toml.

cayu cloud deploy

Section titled “cayu cloud deploy”
Terminal window
usage: cayu cloud deploy [-h] [--manifest MANIFEST] [--revision REVISION]
                         [--application APPLICATION] [--no-wait]
                         [--no-promote] [--retry-failed | --no-retry-failed]
                         [--skip-deploy-check] [--poll-seconds POLL_SECONDS]
                         [--wait-seconds WAIT_SECONDS]
                         [source]


Publish and activate an immutable Agent release from a local directory or
repository.


positional arguments:
  source


options:
  -h, --help            show this help message and exit
  --manifest MANIFEST
  --revision REVISION
  --application APPLICATION
                        Create or update this application slug; defaults to
                        the application declared in cayu-cloud.toml.
  --no-wait
  --no-promote
  --retry-failed, --no-retry-failed
                        Retry a replayed Cloud-side terminal failure with a
                        fresh submission key (default: enabled).
  --skip-deploy-check   Upload even when the local `cayu check --deploy` finds
                        problems that stop a public service starting on Cayu
                        Cloud.
  --poll-seconds POLL_SECONDS
  --wait-seconds WAIT_SECONDS

cayu cloud deployment

Section titled “cayu cloud deployment”
Terminal window
usage: cayu cloud deployment [-h]
                             {logs,status,timeline,wait,promote,retry} ...


Inspect, wait for, or promote one immutable Agent release.


positional arguments:
  {logs,status,timeline,wait,promote,retry}


options:
  -h, --help            show this help message and exit

cayu cloud deployment logs

Section titled “cayu cloud deployment logs”
Terminal window
usage: cayu cloud deployment logs [-h] --application APPLICATION
                                  [--diagnostic-offset DIAGNOSTIC_OFFSET]
                                  [--diagnostic-limit DIAGNOSTIC_LIMIT]
                                  deployment_id


Read structured publication logs for one release.


positional arguments:
  deployment_id


options:
  -h, --help            show this help message and exit
  --application APPLICATION
  --diagnostic-offset DIAGNOSTIC_OFFSET
  --diagnostic-limit DIAGNOSTIC_LIMIT

cayu cloud deployment status

Section titled “cayu cloud deployment status”
Terminal window
usage: cayu cloud deployment status [-h] --application APPLICATION
                                    deployment_id


Show the current publication status of one release.


positional arguments:
  deployment_id


options:
  -h, --help            show this help message and exit
  --application APPLICATION

cayu cloud deployment timeline

Section titled “cayu cloud deployment timeline”
Terminal window
usage: cayu cloud deployment timeline [-h] --application APPLICATION
                                      deployment_id


Show the publication milestones for one release.


positional arguments:
  deployment_id


options:
  -h, --help            show this help message and exit
  --application APPLICATION

cayu cloud deployment wait

Section titled “cayu cloud deployment wait”
Terminal window
usage: cayu cloud deployment wait [-h] --application APPLICATION
                                  [--poll-seconds POLL_SECONDS]
                                  [--wait-seconds WAIT_SECONDS]
                                  deployment_id


Wait until one release is promotable or terminal.


positional arguments:
  deployment_id


options:
  -h, --help            show this help message and exit
  --application APPLICATION
  --poll-seconds POLL_SECONDS
  --wait-seconds WAIT_SECONDS

cayu cloud deployment promote

Section titled “cayu cloud deployment promote”
Terminal window
usage: cayu cloud deployment promote [-h] --application APPLICATION
                                     deployment_id


Select a smoke-tested release for its Agent application.


positional arguments:
  deployment_id


options:
  -h, --help            show this help message and exit
  --application APPLICATION

cayu cloud deployment retry

Section titled “cayu cloud deployment retry”
Terminal window
usage: cayu cloud deployment retry [-h] --application APPLICATION
                                   [--idempotency-key IDEMPOTENCY_KEY]
                                   deployment_id


Create a new immutable release attempt from retained source.


positional arguments:
  deployment_id


options:
  -h, --help            show this help message and exit
  --application APPLICATION
  --idempotency-key IDEMPOTENCY_KEY

cayu cloud rollback

Section titled “cayu cloud rollback”
Terminal window
usage: cayu cloud rollback [-h] --application APPLICATION deployment_id


Select an earlier immutable release and recreate the Agent service.


positional arguments:
  deployment_id


options:
  -h, --help            show this help message and exit
  --application APPLICATION

cayu cloud runtimes

Section titled “cayu cloud runtimes”
Terminal window
usage: cayu cloud runtimes [-h] {list,status} ...


Inspect retained immutable runtime artifacts for an Agent.


positional arguments:
  {list,status}


options:
  -h, --help     show this help message and exit

cayu cloud runtimes list

Section titled “cayu cloud runtimes list”
Terminal window
usage: cayu cloud runtimes list [-h] --application APPLICATION


List retained runtime artifacts for an Agent application.


options:
  -h, --help            show this help message and exit
  --application APPLICATION

cayu cloud runtimes status

Section titled “cayu cloud runtimes status”
Terminal window
usage: cayu cloud runtimes status [-h] --application APPLICATION artifact_id


Show one retained runtime artifact and its lifecycle state.


positional arguments:
  artifact_id


options:
  -h, --help            show this help message and exit
  --application APPLICATION

cayu cloud service

Section titled “cayu cloud service”
Terminal window
usage: cayu cloud service [-h]
                          {credentials,destroy,logs,restart,sleep,status,wake} ...


Operate the long-running web, worker, and schedule infrastructure.


positional arguments:
  {credentials,destroy,logs,restart,sleep,status,wake}


options:
  -h, --help            show this help message and exit

cayu cloud service credentials

Section titled “cayu cloud service credentials”
Terminal window
usage: cayu cloud service credentials [-h] --application APPLICATION


Show the Agent's own /cayu/ operator username and password. The output is a
credential: keep it out of logs and shared terminals.


options:
  -h, --help            show this help message and exit
  --application APPLICATION

cayu cloud service destroy

Section titled “cayu cloud service destroy”
Terminal window
usage: cayu cloud service destroy [-h] --application APPLICATION
                                  [--poll-seconds POLL_SECONDS]
                                  [--wait-seconds WAIT_SECONDS]


Remove the Agent services and schedules but retain its releases.


options:
  -h, --help            show this help message and exit
  --application APPLICATION
  --poll-seconds POLL_SECONDS
  --wait-seconds WAIT_SECONDS

cayu cloud service logs

Section titled “cayu cloud service logs”
Terminal window
usage: cayu cloud service logs [-h] --application APPLICATION


Read recent infrastructure logs from the Agent service.


options:
  -h, --help            show this help message and exit
  --application APPLICATION

cayu cloud service restart

Section titled “cayu cloud service restart”
Terminal window
usage: cayu cloud service restart [-h] --application APPLICATION


Restart the Agent service on its selected immutable release.


options:
  -h, --help            show this help message and exit
  --application APPLICATION

cayu cloud service sleep

Section titled “cayu cloud service sleep”
Terminal window
usage: cayu cloud service sleep [-h] --application APPLICATION


Scale only the Agent web service to zero.


options:
  -h, --help            show this help message and exit
  --application APPLICATION

cayu cloud service status

Section titled “cayu cloud service status”
Terminal window
usage: cayu cloud service status [-h] --application APPLICATION


Show the Agent web, worker, schedule, and endpoint state.


options:
  -h, --help            show this help message and exit
  --application APPLICATION

cayu cloud service wake

Section titled “cayu cloud service wake”
Terminal window
usage: cayu cloud service wake [-h] --application APPLICATION


Start only the Agent web service.


options:
  -h, --help            show this help message and exit
  --application APPLICATION

cayu cloud env

Section titled “cayu cloud env”
Terminal window
usage: cayu cloud env [-h] {list,set,unset} ...


Manage Agent-owned environment variables and write-only secrets.


positional arguments:
  {list,set,unset}


options:
  -h, --help        show this help message and exit

cayu cloud env list

Section titled “cayu cloud env list”
Terminal window
usage: cayu cloud env list [-h] --application APPLICATION


List environment variables without revealing secret values.


options:
  -h, --help            show this help message and exit
  --application APPLICATION

cayu cloud env set

Section titled “cayu cloud env set”
Terminal window
usage: cayu cloud env set [-h] --application APPLICATION [--secret]
                          [--value-file VALUE_FILE]
                          assignment


Set NAME=value, or use NAME --secret --value-file PATH.


positional arguments:
  assignment


options:
  -h, --help            show this help message and exit
  --application APPLICATION
  --secret
  --value-file VALUE_FILE
                        Read a secret from PATH; use - for standard input.

cayu cloud env unset

Section titled “cayu cloud env unset”
Terminal window
usage: cayu cloud env unset [-h] --application APPLICATION name


Remove one Agent environment variable.


positional arguments:
  name


options:
  -h, --help            show this help message and exit
  --application APPLICATION

cayu cloud evidence

Section titled “cayu cloud evidence”
Terminal window
usage: cayu cloud evidence [-h] {list,show,verify} ...


Inspect local content-free records produced by Cloud commands.


positional arguments:
  {list,show,verify}


options:
  -h, --help          show this help message and exit

cayu cloud evidence list

Section titled “cayu cloud evidence list”
Terminal window
usage: cayu cloud evidence list [-h]


List local Cayu Cloud command evidence records.


options:
  -h, --help  show this help message and exit

cayu cloud evidence show

Section titled “cayu cloud evidence show”
Terminal window
usage: cayu cloud evidence show [-h] evidence_id


Show one local content-free evidence record.


positional arguments:
  evidence_id


options:
  -h, --help   show this help message and exit

cayu cloud evidence verify

Section titled “cayu cloud evidence verify”
Terminal window
usage: cayu cloud evidence verify [-h]


Verify the integrity of every local evidence record.


options:
  -h, --help  show this help message and exit
Section titled “Related guides”

Getting started · Operations · Configuration