Skip to content

docs(cli): sync command reference + env vars with the CLI #104

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
indykish merged 2 commits into from
Jun 19, 2026
Merged

docs(cli): sync command reference + env vars with the CLI #104

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7eedb42
docs(cli): sync command reference + env vars with the CLI
indykish Jun 19, 2026
938c60b
docs(cli): order overview table to match section order
indykish Jun 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 50 additions & 0 deletions cli/agentsfleet.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,14 @@ description: "Complete agentsfleet command reference."
|-------|----------|
| Authentication | `login`, `logout`, `auth status` |
| Agents (top-level) | `install --from`, `list`, `status`, `stop`, `resume`, `kill`, `delete`, `logs`, `events`, `steer` |
| Agents (in-place update) | `agent update --from` |
| Credentials | `credential add`, `credential show`, `credential list`, `credential delete` |
| Workspaces | `workspace add`, `workspace list`, `workspace use`, `workspace show`, `workspace credentials`, `workspace delete` |
| Memory | `memory list`, `memory search` |
| External agents | `agent-key add`, `agent-key list`, `agent-key delete` |
| Integration grants | `grant list`, `grant delete` |
| Billing | `billing show` |
| Tenant provider | `tenant provider show`, `tenant provider add`, `tenant provider delete` |
| Diagnostics | `doctor` |

Every command accepts the [global flags](/cli/flags). Every command that returns structured data supports `--json` for machine-readable output.
Expand Down Expand Up @@ -96,6 +99,18 @@ agentsfleet install --from ~/.config/agentsfleet/samples/platform-ops

The `samples/` directory ships with `agentsfleet` and contains the flagship `platform-ops` sample. The host-agent install skill (`/agentsfleet-install-platform-ops`) drives this command under the hood. See [Quickstart](/quickstart) and [Templates](/agents/templates).

### `agentsfleet agent update <agent_id> --from <path>`

Re-parse `SKILL.md` and `TRIGGER.md` from a local bundle and `PATCH` them onto an existing agent — the in-place counterpart to `install`. Use it to roll a configuration change onto an already-registered agent without re-creating it.

```bash
agentsfleet agent update 01900000-0000-7000-8000-000000000001 --from ~/.config/agentsfleet/samples/platform-ops
```

| Flag | Default | Purpose |
|------|---------|---------|
| `--from <path>` | *(required)* | Local bundle whose `SKILL.md` + `TRIGGER.md` are re-parsed and patched onto the agent. |

### `agentsfleet list`

List agents in the active workspace. Keyset-paginated over `(created_at, id)` — the dashboard `/agents` page uses the same contract.
Expand Down Expand Up @@ -290,6 +305,41 @@ agentsfleet workspace delete 0198a7b0-3c2d-7f14-9a08-1b6e4d2f8c50

---

## Memory

A read-only window into an agent's durable memory. There is no write verb — the tenant memory plane is read-only by architecture; agents write their own memory during runs.

### `agentsfleet memory list`

List memory entries newest-first.

```bash
agentsfleet memory list --agent 01900000-0000-7000-8000-000000000001
```

| Flag | Default | Purpose |
|------|---------|---------|
| `--agent <id>` | *(active)* | Agent whose memory to read. |
| `--category <name>` | *(all)* | Filter to a single memory category. |
| `--limit <n>` | server default | Max entries to return (clamped to the server cap). |
| `--workspace <id>` | *(active)* | Override the active workspace for this call. |

### `agentsfleet memory search <query>`

Substring-search keys and content across an agent's memory.

```bash
agentsfleet memory search "deploy" --agent 01900000-0000-7000-8000-000000000001
```

| Flag | Default | Purpose |
|------|---------|---------|
| `--agent <id>` | *(active)* | Agent whose memory to search. |
| `--limit <n>` | server default | Max entries to return (clamped to the server cap). |
| `--workspace <id>` | *(active)* | Override the active workspace for this call. |

---

## External agents

External agents are API-key–authenticated callers (LangGraph, CrewAI, Composio, your own code) that drive a specific agent programmatically.
Expand Down
1 change: 1 addition & 0 deletions cli/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ Every **other command** then resolves its token, and the order is TTY-aware:
| Variable | Purpose | Default |
|----------|---------|---------|
| `AGENTSFLEET_API_URL` | API base URL | `https://api.agentsfleet.net` |
| `AGENTSFLEET_DASHBOARD_URL` | Dashboard base URL — used for the login verification page. | `https://app.agentsfleet.net` |
| `AGENTSFLEET_TOKEN` | Auth token (for CI and scripts; user-bound, from `agentsfleet login`) | *(from `agentsfleet login`)* |
| `AGENTSFLEET_API_KEY` | Service auth (machine-bound, from `agentsfleet agent-key add`). Use this for service-to-service calls and external agents (LangGraph, CrewAI, Composio, your own code). | — |
| `AGENTSFLEET_STATE_DIR` | Directory for local CLI state (credentials, telemetry, session). | `~/.config/agentsfleet` |
Expand Down
Loading