Every agentserve command follows the same shape:
agentserve <resource> [sub-resource] <verb> [arguments] [options]Some resource groups also accept a singular alias: agentserve workflow get and
agentserve workflows get are the same command. knowledge also answers to kb.
Each group’s reference lists its supported aliases.
Global options
These apply to every command, and may be written before or after it.
| Option | Description |
|---|---|
-P, --profile <name> | Profile to use (env: AGENT_SERVE_PROFILE). |
--endpoint <url> | Deployment to talk to (env: AGENT_SERVE_BASE_URL). |
-w, --workspace <id> | Workspace to target (env: AGENT_SERVE_WORKSPACE). |
--output <format> | Output format for this command. Accepted values: table, json, yaml, text. |
Command groups
| Group | Description |
|---|---|
agentserve profiles | List profiles or add a workspace profile that shares a stored login |
agentserve telemetry | Control anonymous usage reporting |
agentserve runner | Run Agent Serve jobs on this machine (link, run, status, unlink) |
agentserve cli | Discover commands in this CLI |
agentserve model | Work with the semantic model as code (agentserve.model.yaml) |
agentserve app | Build, run and ship apps that run inside a workspace (agentserve.app.yaml) (OAuth login or personal API key required) |
agentserve apps | Manage apps |
agentserve audit-logs | Manage audit logs |
agentserve billing | Manage billing |
agentserve blocks | Manage blocks |
agentserve chat-deployments | Manage chat deployments |
agentserve connector-types | Manage connector types |
agentserve credentials | Manage credentials |
agentserve custom-tools | Manage custom tools |
agentserve files | Manage files |
agentserve knowledge | Manage knowledge |
agentserve logs | Manage logs |
agentserve mcp-servers | Manage mcp servers |
agentserve meta | Manage meta |
agentserve organizations | Manage organizations |
agentserve permission-groups | Manage permission groups |
agentserve relays | Manage relays |
agentserve sandboxes | Manage sandboxes |
agentserve secrets | Manage secrets |
agentserve selectors | Manage selectors |
agentserve semantic-model | Manage semantic model |
agentserve skills | Manage skills |
agentserve slides | Manage slides |
agentserve spaces | Manage spaces |
agentserve tables | Manage tables |
agentserve tools | Manage tools |
agentserve workflow-mcp-servers | Manage workflow mcp servers |
agentserve workflows | Manage workflows |
agentserve workspaces | Manage workspaces |
Log in through the browser and store the login for the profile
agentserve login [options]Options
| Option | Required | Description |
|---|---|---|
--method <method> | No | Credential to obtain: oauth requires OAuth support; api-key creates a permanent key through pairing (auto-selects when omitted). Accepted values: oauth, api-key. |
--no-browser | No | Print the approval URL without opening it (either login method). |
--read-only | No | Ask only for permission to read, never to change anything. |
--callback-port <port> | No | Pin the local port the browser returns to. |
-y, --yes | No | Overwrite an existing API-key profile without prompting. |
Sign out and remove the profile's stored login
agentserve logout [options]Options
| Option | Required | Description |
|---|---|---|
--all | No | Remove the profile entirely, including its settings. |
Show the resolved profile, where each setting came from, and whether it works
agentserve whoami [options]Options
| Option | Required | Description |
|---|---|---|
--no-verify | No | Skip the API check and only print the resolved settings. |
Switch a profile's default workspace, or set its endpoint or output format
agentserve configure [options]Options
| Option | Required | Description |
|---|---|---|
--set-endpoint <url> | No | Agent Serve deployment to talk to. |
--set-workspace <id> | No | Default workspace for workspace-scoped commands. |
--set-output <format> | No | Default output format (table | json | yaml | text). |
--unset <key...> | No | Remove settings (endpoint, workspace, output). |
Update this global CLI installation to the newest release on its channel
agentserve update [options]Options
| Option | Required | Description |
|---|---|---|
--package-manager <manager> | No | Package manager that installed this copy. Accepted values: npm, pnpm, bun, yarn. |
Ask agent serve and print the reply
agentserve chat <message> [options]Arguments
| Argument | Required | Description |
|---|---|---|
message | Yes | What to ask Agent Serve |
Options
| Option | Required | Description |
|---|---|---|
-c, --conversation <id> | No | Continue the conversation with this ID. |