Every command below also accepts the global options.
Create a new app from a starter template
agentserve app init [dir] [options]Arguments
| Argument | Required | Description |
|---|---|---|
dir | No | Folder to create the app in |
Options
| Option | Required | Description |
|---|---|---|
-t, --template <name> | No | Starter template. Accepted values: blank, sales-cockpit, field-visit-logger, deal-desk, support-triage, ops-exceptions, knowledge-assistant. Defaults to blank. |
--name <slug> | No | App name in the manifest; defaults to the folder name. |
--title <text> | No | App title people see; defaults to one made from the name. |
--force | No | Add the app to a folder that already has other files. |
--list | No | List the starter templates and exit. |
--json | No | Print machine-readable JSON (same as --output json). |
Build the app and run it locally in the same sandboxed frame the workspace uses, with your own access
agentserve app dev [dir] [options]Build the app and run it locally in the same sandboxed frame the workspace uses, with your own access (OAuth login or personal API key required)
Arguments
| Argument | Required | Description |
|---|---|---|
dir | No | App folder |
Options
| Option | Required | Description |
|---|---|---|
-p, --port <port> | No | Port for the local host page. Defaults to 5175. |
--page <id> | No | Page to open first. |
--launch <json> | No | What launch.get answers, as a plugin command or action opens the page: {"kind":"command","name":"brief","args":{"file":"q3"}}. |
--build-command <command> | No | Command that builds the app (default: <package manager> run build). |
--no-build | No | Do not build; serve the existing output and reload when it changes. |
--no-open | No | Do not open a browser. |
Build the app, pack it and upload it as a draft version
agentserve app deploy [dir] [options]Build the app, pack it and upload it as a draft version (OAuth login or personal API key required)
Arguments
| Argument | Required | Description |
|---|---|---|
dir | No | App folder |
Options
| Option | Required | Description |
|---|---|---|
--build-command <command> | No | Command that builds the app (default: <package manager> run build). |
--no-build | No | Upload the existing build output without building. |
--json | No | Print machine-readable JSON (same as --output json). |
Publish a draft version so workspaces can install it (admin)
agentserve app publish <version> [options]Publish a draft version so workspaces can install it (admin) (OAuth login or personal API key required)
Arguments
| Argument | Required | Description |
|---|---|---|
version | Yes | Version to publish, such as 1.2.0, or its id |
Options
| Option | Required | Description |
|---|---|---|
--app <name-or-id> | No | App to act on; defaults to the name in ./agentserve.app.yaml. |
--rollout | No | Also move this workspace's install to the version. |
--json | No | Print machine-readable JSON (same as --output json). |
Move this workspace's install to an earlier published version (admin)
agentserve app rollback <version> [options]Move this workspace's install to an earlier published version (admin) (OAuth login or personal API key required)
Arguments
| Argument | Required | Description |
|---|---|---|
version | Yes | Published version to run, such as 1.1.0, or its id |
Options
| Option | Required | Description |
|---|---|---|
--app <name-or-id> | No | App to act on; defaults to the name in ./agentserve.app.yaml. |
--json | No | Print machine-readable JSON (same as --output json). |
Install a published app in the workspace (admin); pick it with -w, --workspace
agentserve app install [options]Install a published app in the workspace (admin); pick it with -w, --workspace (OAuth login or personal API key required)
Options
| Option | Required | Description |
|---|---|---|
--app <name-or-id> | No | App to act on; defaults to the name in ./agentserve.app.yaml. |
--to-version <version> | No | Published version to install; defaults to the highest. |
--json | No | Print machine-readable JSON (same as --output json). |
Show the install's audit trail, oldest first; --follow keeps watching
agentserve app logs [options]Show the install's audit trail, oldest first; --follow keeps watching (OAuth login or personal API key required)
Options
| Option | Required | Description |
|---|---|---|
--app <name-or-id> | No | App to act on; defaults to the name in ./agentserve.app.yaml. |
-f, --follow | No | Keep polling for new entries until Ctrl-C. |
--interval <seconds> | No | Seconds between polls with --follow. Defaults to 5. |
--json | No | Print machine-readable JSON (same as --output json). |
Show this month's spend against the app's budget, by source
agentserve app usage [options]Show this month's spend against the app's budget, by source (OAuth login or personal API key required)
Options
| Option | Required | Description |
|---|---|---|
--app <name-or-id> | No | App to act on; defaults to the name in ./agentserve.app.yaml. |
--json | No | Print machine-readable JSON (same as --output json). |
Show what the app may reach, installed and in the local manifest
agentserve app permissions [dir] [options]Show what the app may reach, installed and in the local manifest (OAuth login or personal API key required)
Arguments
| Argument | Required | Description |
|---|---|---|
dir | No | App folder whose manifest to compare |
Options
| Option | Required | Description |
|---|---|---|
--app <name-or-id> | No | App to act on; defaults to the name in ./agentserve.app.yaml. |
--json | No | Print machine-readable JSON (same as --output json). |
Set a secret; prompts without echo when --value is not given
agentserve app secrets set <name> [options]Set a secret; prompts without echo when --value is not given (OAuth login or personal API key required)
Arguments
| Argument | Required | Description |
|---|---|---|
name | Yes | Secret name, such as API_TOKEN |
Options
| Option | Required | Description |
|---|---|---|
--value <value|@file> | No | Secret value. Inline values land in shell history; @path reads a file and @- stdin, verbatim. |
--app <name-or-id> | No | App to act on; defaults to the name in ./agentserve.app.yaml. |
--json | No | Print machine-readable JSON (same as --output json). |
List secret names and when each was set
agentserve app secrets list [options]List secret names and when each was set (OAuth login or personal API key required)
Options
| Option | Required | Description |
|---|---|---|
--app <name-or-id> | No | App to act on; defaults to the name in ./agentserve.app.yaml. |
--json | No | Print machine-readable JSON (same as --output json). |
Delete a secret
agentserve app secrets delete <name> [options]Delete a secret (OAuth login or personal API key required)
Arguments
| Argument | Required | Description |
|---|---|---|
name | Yes | Secret name |
Options
| Option | Required | Description |
|---|---|---|
--app <name-or-id> | No | App to act on; defaults to the name in ./agentserve.app.yaml. |
--json | No | Print machine-readable JSON (same as --output json). |