CLI reference

Complete command and flag lookup. Run cayu COMMAND --help for the version installed in your project.

usage: cayu [-h] [--version]
            {version,agent,auth,check,cloud,console,dashboard,diagnostics,doctor,eval,generate,guide,inspect,lambda-microvm,new,recovery,serve,session,storage,worker} ...

Developer/admin CLI for Cayu agent projects.

positional arguments:
  {version,agent,auth,check,cloud,console,dashboard,diagnostics,doctor,eval,generate,guide,inspect,lambda-microvm,new,recovery,serve,session,storage,worker}
    version             Print the Cayu version.
    agent               Manage portable Cayu agents.
    auth                Manage local provider sign-ins.
    check               Validate a booted Cayu project with actionable
                        diagnostics.
    cloud               Manage Cayu Cloud.
    console             Open an IPython console with a booted Cayu
                        application.
    dashboard           Manage the bundled Cayu control-plane source.
    diagnostics         Read live diagnostics from a running Cayu server.
    doctor              Write a bounded, redacted diagnostic support bundle.
    eval                Run and report Cayu runtime-native evals.
    generate            Plan or add reviewable generated Cayu application
                        slices.
    guide               Print package-shipped Cayu application guidance.
    inspect             Describe a booted Cayu project without running it.
    lambda-microvm      Manage AWS Lambda MicroVM support artifacts.
    new                 Scaffold a new Cayu agent project.
    recovery            Plan and execute bounded recovery through the
                        registered application.
    serve               Serve a configured Cayu project's control plane.
    session             Inspect durable sessions and resolve unavailable
                        provider work.
    storage             Inspect, migrate, and export Cayu storage.
    worker              Run a configured Cayu worker entrypoint.

options:
  -h, --help            show this help message and exit
  --version             show program's version number and exit

Commands

• cayu version
• cayu agent
• cayu auth
• cayu check
• cayu cloud
• cayu console
• cayu dashboard
• cayu diagnostics
• cayu doctor
• cayu eval
• cayu generate
• cayu guide
• cayu inspect
• cayu lambda-microvm
• cayu new
• cayu recovery
• cayu serve
• cayu session
• cayu storage
• cayu worker

Automation and exit behavior

CLI exit semantics are command-specific. cayu check --fail-on warning --json fails when diagnostics reach the requested severity; use it before tests and evals. --json is available only on commands whose help declares it. An invalid argument is a parser error; a successful inspection does not prove live-provider behavior. Capture command exit status and the structured result together. Use the generated project test and eval commands for behavioral verification.

Project and storage selection

Commands that boot an application use [tool.cayu].factory and construct a fresh process-local app. Storage-only commands use their explicit selectors, then CAYU_DATABASE_URL, project configuration and the existing conventional local store. Read application anatomy and storage before automating across processes.