simple is the command-line tool in @simple-ai-lab/cli. It signs in as you, with your dashboard account, and every command runs with your own permissions. Install it and make your first publish with the quickstart; Agent projects explains the project the commands operate on.
--help on any command shows every flag, including the ones left out here. Commands print one line per result, or the raw API response with --json where it is offered; a failure prints simple: <message> and exits with code 1.
Authentication
simple login
Signs in through your browser with your dashboard account. When you belong to more than one organization, the CLI asks which one to use, and remembers the choice.
simple whoami
Prints who you are signed in as and which organization the session is on.
simple logout
Signs out and removes the saved credentials. --all signs out every saved sign-in.
Agent Projects
Commands for an existing project work on the current directory; pass--directory <path> to point at another one. simple init takes its target as the positional [directory] argument instead.
simple init [directory]
Creates an agent project: a package.json, tsconfig.json, a starter agent.ts, and an empty simple.lock.json. Defaults to the current directory. Run pnpm install in it afterwards.
simple pull <agent-uuid>
Pulls one production branch of an agent, with the exact Action versions it uses, into code. The UUID is on the agent’s page in the dashboard.
simple typecheck
Typechecks and compiles the project, including the handlers under actions/. Uses the package manager named in the project’s package.json, pnpm by default.
simple diff
Lists the agent and Action changes between your source and simple.lock.json. Nothing is sent to production.
simple publish
Validates the project on the server, creates or revises the Actions that changed, then creates one agent commit pinned to those versions. Refuses if the branch or an Action changed in production since your last pull.
simple actions upgrade
Accepts the newest production versions of the Actions already in the lock file. See Validate and publish for how this interacts with defineAgent(...) source.
Organization Resources
Tags, analyzers, scorecards, scorecard metrics, and post-call workflows belong to the organization, and an agent references them by UUID. Each family haslist, which prints one line per item starting with its UUID, and create, which prints the new item’s name and UUID:
The most used
create flags:
Definition files and worked examples for each resource are on Agents as code.
Updating
simple update [version]
Updates the CLI to the latest release, or to the version or tag you name, using the package manager that installed it globally. --dry-run shows what it detected and the command it would run, without installing. If the CLI is a project dependency rather than a global install, update it with that project’s package manager instead.