Command reference

Synopsis

The command-line interface (CLI) manages workspaces, fleets, access, secrets, and memory.

agentsfleet [GLOBAL_OPTIONS] <COMMAND>

<COMMAND> comes from the tables below. Run any command with --help to see its accepted values. Identifier placeholders come from the matching create or list command. You choose name, path, provider, message, and query values.

Example with output

agentsfleet --help

Usage: agentsfleet [options] [command]

Options:
  -v, --version    Show version
  --api <url>      API base URL
  --json           Machine-readable JSON output
  <varies>

Commands:
  login [options]  Authenticate via browser
  workspace        Manage workspaces
  fleet            Fleet management subcommands
  <varies>

Options

Global options

<API_URL> is the API base URL for your deployment.

Option	Effect	Default	Unit or range
`-v`, `--version`	Prints the client version and exits.	`false`	Boolean
`--api <API_URL>`	Sends requests to this API URL.	`https://api.agentsfleet.net`	URL beginning with `http://` or `https://`
`--json`	Prints JSON when the command supports it.	`false`	Boolean
`--no-input`	Returns an error instead of asking a question.	`false`	Boolean
`--no-open`	Prints the login URL instead of opening a browser.	`false`	Boolean
`-h`, `--help`	Prints help and exits.	`false`	Boolean

Account and diagnosis

Command	Effect
`agentsfleet login`	Signs in through a browser and saves a durable credential for this computer.
`agentsfleet logout`	Revokes this computer’s credential and any unfinished sign-in, then clears local credentials. Browser sessions stay signed in.
`agentsfleet auth status`	Shows the token source, claims, and server status.
`agentsfleet doctor`	Checks client settings, authentication, and API access.

Workspaces and access

Command	Effect
`agentsfleet workspace create [NAME]`	Creates a workspace and selects it.
`agentsfleet workspace list`	Lists workspaces.
`agentsfleet workspace use <WORKSPACE_ID>`	Selects the active workspace on this computer.
`agentsfleet workspace show [WORKSPACE_ID]`	Shows one workspace.
`agentsfleet workspace secrets`	Prints the secret command and dashboard path.
`agentsfleet workspace delete <WORKSPACE_ID>`	Removes one workspace from local client state. Remote data remains.
`agentsfleet api-key create`	Creates a tenant API key. The raw key appears once.
`agentsfleet api-key list`	Lists tenant API keys.
`agentsfleet api-key revoke <API_KEY_ID>`	Revokes a tenant API key. Calls using that key fail.
`agentsfleet api-key delete <API_KEY_ID>`	Deletes metadata for a revoked tenant API key.
`agentsfleet connector list`	Lists connector setup and connection state.
`agentsfleet connector status <PROVIDER>`	Shows one connector.
`agentsfleet grant list --fleet <FLEET_ID>`	Lists integration grants for one fleet.
`agentsfleet grant delete --fleet <FLEET_ID> <GRANT_ID>`	Revokes one grant. Later access through that grant fails.

Fleets

Command	Effect
`agentsfleet library`	Lists installable library entries.
`agentsfleet install --library <LIBRARY_ID>`	Installs one library entry.
`agentsfleet fleet update <FLEET_ID> --from <PATH>`	Updates a fleet from a local bundle.
`agentsfleet list`	Lists fleets in the active workspace.
`agentsfleet status`	Shows every fleet in the active workspace.
`agentsfleet stop <FLEET_ID>`	Stops new work. You can resume the fleet.
`agentsfleet resume <FLEET_ID>`	Resumes a stopped or paused fleet.
`agentsfleet kill <FLEET_ID>`	Marks a fleet as killed. This cannot be undone.
`agentsfleet delete <FLEET_ID>`	Deletes a killed fleet and its stored data. This cannot be undone.
`agentsfleet logs [FLEET_ID]`	Shows recent activity.
`agentsfleet events <FLEET_ID>`	Lists historical events with filters.
`agentsfleet steer <FLEET_ID> [MESSAGE]`	Sends a message and streams the response.

agentsfleet delete has no dry-run option. Run agentsfleet kill first, then check the fleet identifier before deletion.

Secrets and memory

Command	Effect
`agentsfleet secret create <NAME>`	Stores a JSON object in the workspace vault under a name that is free. A name already in use is reported as skipped, and nothing is written.
`agentsfleet secret create <NAME> --provider <ID> --api-key <KEY> --model <MODEL>`	Stores a model-provider credential. `--provider` and `--model` are both checked against the model catalogue your server serves — run `agentsfleet models` to list it. `--provider openai-compatible` adds a required `https` `--base-url`, makes `--api-key` optional, and accepts any `--model`.
`agentsfleet secret update <NAME>`	Replaces a stored secret without releasing its name. It accepts the same data and provider options as `agentsfleet secret create`.
`agentsfleet secret show <NAME>`	Confirms that a secret exists without showing its value.
`agentsfleet secret list`	Lists secret names and metadata.
`agentsfleet secret delete <NAME>`	Deletes a secret. Fleets using the secret fail on their next use.
`agentsfleet memory list --fleet <FLEET_ID>`	Lists memory entries newest first.
`agentsfleet memory search <QUERY> --fleet <FLEET_ID>`	Searches memory keys and content.

agentsfleet secret delete has no dry-run option. The deleted secret value cannot be recovered.

Model catalogue

Command	Effect
`agentsfleet models`	Lists every model the server prices: provider, model id, context window, and per-million-token input and output rates.
`agentsfleet models --provider <ID>`	Lists one provider’s models.

The dashboard’s model picker reads the same catalogue, so both surfaces offer the same providers. Rates apply under platform-managed posture; a self-managed credential is billed by your own provider account, and its rows show a dash. An empty catalogue means an administrator has not primed this server yet. While it is empty, --provider accepts any value and the server validates the credential.

Tenant settings

Command	Effect
`agentsfleet tenant provider show`	Shows the active model provider.
`agentsfleet tenant provider create --secret <NAME>`	Selects a self-managed provider secret.
`agentsfleet tenant provider delete`	Returns the tenant to the platform provider.
`agentsfleet billing show`	Shows the tenant balance and recent charges.

Errors

Exit code	Meaning
`0`	The command succeeded.
`1`	Authentication, session, or unexpected failure.
`2`	Network failure or rate limit.
`3`	The API returned a server failure.
`4`	The invocation was rejected: a missing argument, a missing or unrecognized flag, a value that failed validation, or an unknown command.
`5`	Local configuration is missing or invalid.
`130`	You interrupted the command.

A rejected invocation is answered before any request is sent. The form is always the same: what is wrong, then the command that puts it right. What is wrong may be an absent argument, a value that failed validation, or an unrecognized command.

$ agentsfleet events
✕ error: missing required argument 'fleet_id'
  Suggestion: usage: agentsfleet events [options] <fleet_id>

Under --json the same rejection is a parseable envelope on standard error, carrying a stable code you can switch on:

{
  "error": {
    "code": "MISSING_ARGUMENT",
    "message": "missing required argument 'fleet_id'"
  }
}

The codes are MISSING_ARGUMENT, MISSING_OPTION_VALUE, MISSING_REQUIRED_OPTION, UNKNOWN_COMMAND, UNKNOWN_OPTION, INVALID_ARGUMENT, and EXCESS_ARGUMENTS. API failures include a stable error code and request identifier when the server supplies them. Use both values when reporting a problem.

Getting started

Fleets

Workspaces

Runners

Cost control

CLI reference

Updates

Command reference

Command reference

Synopsis

Example with output

Options

Global options

Account and diagnosis

Workspaces and access

Fleets

Secrets and memory

Model catalogue

Tenant settings

Errors

​Command reference

​Synopsis

​Example with output

​Options

​Global options

​Account and diagnosis

​Workspaces and access

​Fleets

​Secrets and memory

​Model catalogue

​Tenant settings

​Errors

​Related pages

Command reference

Synopsis

Example with output

Options

Global options

Account and diagnosis

Workspaces and access

Fleets

Secrets and memory

Model catalogue

Tenant settings

Errors

Related pages