Apps

Every command below also accepts the global options.

Delete app secret

agentserve apps secrets delete <installId> <name> [options]

Delete App Secret (OAuth login or personal API key required)

Arguments

Argument	Required	Description
`installId`	Yes	Install identifier.
`name`	Yes	Secret name.

Options

Option	Required	Description
`-y, --yes`	Yes	Confirm this operation.

List app secrets

agentserve apps secrets list <installId>

List App Secrets (OAuth login or personal API key required)

Arguments

Argument	Required	Description
`installId`	Yes	Install identifier.

Set app secret

agentserve apps secrets update <installId> <name> [options]

Set App Secret (OAuth login or personal API key required)

Arguments

Argument	Required	Description
`installId`	Yes	Install identifier.
`name`	Yes	Secret name.

Options

Option	Required	Description
`--value <value>`	Yes	Write-only secret value. It is never returned.

Get app

agentserve apps get <appId>

Get App (OAuth login or personal API key required)

Arguments

Argument	Required	Description
`appId`	Yes	App identifier.

Get app deployment

agentserve apps deployments get <appId> <deploymentId>

Get App Deployment (OAuth login or personal API key required)

Arguments

Argument	Required	Description
`appId`	Yes	App identifier.
`deploymentId`	Yes	Deployment identifier.

List app deployments

agentserve apps deployments list <appId>

List App Deployments (OAuth login or personal API key required)

Arguments

Argument	Required	Description
`appId`	Yes	App identifier.

Publish app deployment

agentserve apps deployments publish <appId> <deploymentId>

Publish App Deployment (OAuth login or personal API key required)

Arguments

Argument	Required	Description
`appId`	Yes	App identifier.
`deploymentId`	Yes	Deployment identifier.

Get app install

agentserve apps installs get <installId>

Get App Install (OAuth login or personal API key required)

Arguments

Argument	Required	Description
`installId`	Yes	Install identifier.

Install app

agentserve apps installs create [options]

Install App (OAuth login or personal API key required)

Options

Option	Required	Description
`--app-id <value>`	Yes	App to install.
`--version-id <value>`	No	A published version; omit to install the highest published version.

List app installs

agentserve apps installs list

List App Installs (OAuth login or personal API key required)

Uninstall app

agentserve apps installs delete <installId> [options]

Uninstall App (OAuth login or personal API key required)

Arguments

Argument	Required	Description
`installId`	Yes	Install identifier.

Options

Option	Required	Description
`-y, --yes`	Yes	Confirm this operation.

Update app install

agentserve apps installs update <installId> [options]

Update App Install (OAuth login or personal API key required)

Arguments

Argument	Required	Description
`installId`	Yes	Install identifier.

Options

Option	Required	Description
`--version-id <value>`	No	A published version to run instead — an upgrade or a roll back.
`--pinned-for <json\|@file>`	No	Who sees the app as its own rail icon. (JSON, or @path / @- to read a file or stdin).
`--budget-monthly-usd <number\|null>`	No	Monthly budget in USD; null falls back to the manifest budget.
`--status <value>`	No	Turn the app on or off. Accepted values: `active`, `disabled`.

Get app install activity

agentserve apps activity list <installId>

Get App Install Activity (OAuth login or personal API key required)

Arguments

Argument	Required	Description
`installId`	Yes	Install identifier.

List app repositories

agentserve apps repos list <appId>

List App Repositories (OAuth login or personal API key required)

Arguments

Argument	Required	Description
`appId`	Yes	App identifier.

List apps

agentserve apps list

List Apps (OAuth login or personal API key required)

List app tools

agentserve apps tools list [options]

List App Tools (OAuth login or personal API key required)

Options

Option	Required	Description
`--install-id <value>`	No	Only the tools of this install.

Publish app version

agentserve apps publish create <appId> <versionId> [options]

Publish App Version (OAuth login or personal API key required)

Arguments

Argument	Required	Description
`appId`	Yes	App identifier.
`versionId`	Yes	Version identifier.

Options

Option	Required	Description
`--rollout`	No	Also move this workspace's install of the app to the version.
`--no-rollout`	No	Send --rollout as false.

Rebuild app deployment

agentserve apps rebuild create <appId> <deploymentId>

Rebuild App Deployment (OAuth login or personal API key required)

Arguments

Argument	Required	Description
`appId`	Yes	App identifier.
`deploymentId`	Yes	Deployment identifier.

Retire app version

agentserve apps retire create <appId> <versionId> [options]

Retire App Version (OAuth login or personal API key required)

Arguments

Argument	Required	Description
`appId`	Yes	App identifier.
`versionId`	Yes	Version identifier.

Options

Option	Required	Description
`-y, --yes`	Yes	Confirm this operation.

Run app tool

agentserve apps run create <installId> <toolName> [options]

Run App Tool (OAuth login or personal API key required)

Arguments

Argument	Required	Description
`installId`	Yes	Install identifier.
`toolName`	Yes	Tool name.

Options

Option	Required	Description
`--input <json\|@file>`	No	The tool's input; validated against its input schema. (JSON, or @path / @- to read a file or stdin).

Upload app version

agentserve apps versions create

Upload App Version (OAuth login or personal API key required)

On this page