CLI Reference - Agent Stack

The Agent Stack command-line interface (CLI) provides tools to manage agents, configure models, and control the platform directly from your terminal. Usage:

$ agentstack [OPTIONS] COMMAND [ARGS]...

Options:

--help: Show this message and exit.
--install-completion: Install completion for the current shell.
--show-completion: Show completion for the current shell, to copy it or customize the installation.

Commands:

version: Print version of the Agent Stack CLI.
ui: Launch the graphical interface.
model: Manage model providers.
agent: Manage agents.
platform: Manage Agent Stack platform.
client-side-build: Build agent locally using Docker.
build: Build agent from a GitHub repository in…
server: Manage Agent Stack servers and…
self: Manage Agent Stack installation.
user: Manage users.
add: Add a docker image or GitHub repository.
update: Upgrade agent to a newer docker image or…
remove | uninstall | rm | delete: Remove agent.
logs: Stream agent provider logs.
run: Run an agent.
list: List agents.
info: Show agent details.
env
feedback: Manage user feedback for your agents

`agentstack version`

Print version of the Agent Stack CLI. Usage:

$ agentstack version [OPTIONS]

Options:

-v, --verbose: Show verbose output
--help: Show this message and exit.

`agentstack ui`

Launch the graphical interface. Usage:

$ agentstack ui [OPTIONS]

Options:

--help: Show this message and exit.

`agentstack model`

Manage model providers. [Admin only] Usage:

$ agentstack model [OPTIONS] COMMAND [ARGS]...

Options:

--help: Show this message and exit.

Commands:

list: List all available models.
setup: Interactive setup for LLM and embedding…
change | select | default: Change the default model [Admin only]
add: Add a new model provider.
remove | rm | delete
provider

`agentstack model list`

List all available models. Usage:

$ agentstack model list [OPTIONS]

Options:

--help: Show this message and exit.

`agentstack model setup`

Interactive setup for LLM and embedding provider environment variables [Admin only] Usage:

$ agentstack model setup [OPTIONS]

Options:

-v, --verbose: Show verbose output
--help: Show this message and exit.

`agentstack model change | select | default`

Change the default model [Admin only] Usage:

$ agentstack model change | select | default [OPTIONS] [CAPABILITY]:[llm|embedding] [MODEL_ID]

Arguments:

[CAPABILITY]:[llm|embedding]: Which default model to change (llm/embedding)
[MODEL_ID]: Model ID to be used as default

Options:

-y, --yes: Skip confirmation prompts.
--help: Show this message and exit.

`agentstack model add`

Add a new model provider. [Admin only] Usage:

$ agentstack model add [OPTIONS] [CAPABILITY]:[llm|embedding]

Arguments:

[CAPABILITY]:[llm|embedding]: Which default model to change (llm/embedding)

Options:

--help: Show this message and exit.

`agentstack model remove | rm | delete`

Usage:

$ agentstack model remove | rm | delete [OPTIONS] [SEARCH_PATH]

Arguments:

[SEARCH_PATH]: Provider type or part of the provider base url

Options:

-y, --yes: Skip confirmation prompts.
--help: Show this message and exit.

`agentstack model provider`

Usage:

$ agentstack model provider [OPTIONS] COMMAND [ARGS]...

Options:

--help: Show this message and exit.

Commands:

list: List all available model providers.
add: Add a new model provider [Admin only]
remove | rm | delete: Remove a model provider [Admin only]

`agentstack model provider list`

List all available model providers. Usage:

$ agentstack model provider list [OPTIONS]

Options:

--help: Show this message and exit.

`agentstack model provider add`

Add a new model provider [Admin only] Usage:

$ agentstack model provider add [OPTIONS] [CAPABILITY]:[llm|embedding]

Arguments:

[CAPABILITY]:[llm|embedding]: Which default model to change (llm/embedding)

Options:

--help: Show this message and exit.

`agentstack model provider remove | rm | delete`

Remove a model provider [Admin only] Usage:

$ agentstack model provider remove | rm | delete [OPTIONS] [SEARCH_PATH]

Arguments:

[SEARCH_PATH]: Provider type or part of the provider base url

Options:

-y, --yes: Skip confirmation prompts.
--help: Show this message and exit.

`agentstack agent`

Manage agents. Some commands are [Admin only]. Usage:

$ agentstack agent [OPTIONS] COMMAND [ARGS]...

Options:

--help: Show this message and exit.

Commands:

add: Add a docker image or GitHub repository.
update: Upgrade agent to a newer docker image or…
remove | uninstall | rm | delete: Remove agent.
logs: Stream agent provider logs.
run: Run an agent.
list: List agents.
info: Show agent details.
env
feedback: Manage user feedback for your agents

`agentstack agent add`

Add a docker image or GitHub repository. [Admin only] This command supports a variety of GitHub URL formats for deploying agents:

Basic URL: https://github.com/myorg/myrepo
Git Protocol URL: git+https://github.com/myorg/myrepo
URL with .git suffix: https://github.com/myorg/myrepo.git
URL with Version Tag: https://github.com/myorg/myrepo@v1.0.0
URL with Branch Name: https://github.com/myorg/myrepo@my-branch
URL with Subfolder Path: https://github.com/myorg/myrepo#path=/path/to/agent
Combined Formats: https://github.com/myorg/myrepo.git@v1.0.0#path=/path/to/agent
Enterprise GitHub: https://github.mycompany.com/myorg/myrepo
With a custom Dockerfile location: agentstack add --dockerfile /my-agent/path/to/Dockerfile "https://github.com/my-org/my-awesome-agents@main#path=/my-agent"

Usage:

$ agentstack agent add [OPTIONS] [LOCATION]

Arguments:

[LOCATION]: Agent location (public docker image or github url)

Options:

--dockerfile TEXT: Use custom dockerfile path
-v, --verbose: Show verbose output
-y, --yes: Skip confirmation prompts.
--help: Show this message and exit.

`agentstack agent update`

Upgrade agent to a newer docker image or build from GitHub repository. [Admin only] Usage:

$ agentstack agent update [OPTIONS] [SEARCH_PATH] [LOCATION]

Arguments:

[SEARCH_PATH]: Short ID, agent name or part of the provider location of agent to replace
[LOCATION]: Agent location (public docker image or github url)

Options:

--dockerfile TEXT: Use custom dockerfile path
-v, --verbose: Show verbose output
-y, --yes: Skip confirmation prompts.
--help: Show this message and exit.

`agentstack agent remove | uninstall | rm | delete`

Remove agent. [Admin only] Usage:

$ agentstack agent remove | uninstall | rm | delete [OPTIONS] [SEARCH_PATH]

Arguments:

[SEARCH_PATH]: Short ID, agent name or part of the provider location

Options:

-y, --yes: Skip confirmation prompts.
-a, --all: Remove all agents without selection.
--help: Show this message and exit.

`agentstack agent logs`

Stream agent provider logs. [Admin only] Usage:

$ agentstack agent logs [OPTIONS] SEARCH_PATH

Arguments:

SEARCH_PATH: Short ID, agent name or part of the provider location [required]

Options:

--help: Show this message and exit.

`agentstack agent run`

Run an agent. Usage:

$ agentstack agent run [OPTIONS] [SEARCH_PATH] [INPUT]

Arguments:

[SEARCH_PATH]: Short ID, agent name or part of the provider location
[INPUT]: Agent input as text or JSON

Options:

--dump-files PATH: Folder path to save any files returned by the agent
--help: Show this message and exit.

`agentstack agent list`

List agents. Usage:

$ agentstack agent list [OPTIONS]

Options:

--help: Show this message and exit.

`agentstack agent info`

Show agent details. Usage:

$ agentstack agent info [OPTIONS] SEARCH_PATH

Arguments:

SEARCH_PATH: Short ID, agent name or part of the provider location [required]

Options:

--help: Show this message and exit.

`agentstack agent env`

Usage:

$ agentstack agent env [OPTIONS] COMMAND [ARGS]...

Options:

--help: Show this message and exit.

Commands:

add: Store environment variables.
list: List stored environment variables.
remove: Remove environment variable(s).

`agentstack agent env add`

Store environment variables. [Admin only] Usage:

$ agentstack agent env add [OPTIONS] SEARCH_PATH ENV...

Arguments:

SEARCH_PATH: Short ID, agent name or part of the provider location [required]
ENV...: Environment variables to pass to agent [required]

Options:

-y, --yes: Skip confirmation prompts.
--help: Show this message and exit.

`agentstack agent env list`

List stored environment variables. [Admin only] Usage:

$ agentstack agent env list [OPTIONS] SEARCH_PATH

Arguments:

SEARCH_PATH: Short ID, agent name or part of the provider location [required]

Options:

--help: Show this message and exit.

`agentstack agent env remove`

Remove environment variable(s). [Admin only] Usage:

$ agentstack agent env remove [OPTIONS] SEARCH_PATH ENV...

Arguments:

SEARCH_PATH: Short ID, agent name or part of the provider location [required]
ENV...: Environment variable(s) to remove [required]

Options:

-y, --yes: Skip confirmation prompts.
--help: Show this message and exit.

`agentstack agent feedback`

Manage user feedback for your agents Usage:

$ agentstack agent feedback [OPTIONS] COMMAND [ARGS]...

Options:

--help: Show this message and exit.

Commands:

list: List your agent feedback.

`agentstack agent feedback list`

List your agent feedback. [Admin only] Usage:

$ agentstack agent feedback list [OPTIONS] [SEARCH_PATH]

Arguments:

[SEARCH_PATH]: Short ID, agent name or part of the provider location

Options:

--limit INTEGER: Number of results per page [default: 50]
--after TEXT: Cursor for pagination
--help: Show this message and exit.

`agentstack platform`

Manage Agent Stack platform. [Local only] Usage:

$ agentstack platform [OPTIONS] COMMAND [ARGS]...

Options:

--help: Show this message and exit.

Commands:

start: Start Agent Stack platform.
stop: Stop Agent Stack platform.
delete: Delete Agent Stack platform.
import: Import a local docker image into the Agent…
exec: For debugging — execute a command inside…

`agentstack platform start`

Start Agent Stack platform. [Local only] Usage:

$ agentstack platform start [OPTIONS]

Options:

--set TEXT: Set Helm chart values using <key>=<value> syntax [default: <class ‘list’>]
--import TEXT: Import an image from a local Docker CLI into Agent Stack platform [default: <class ‘list’>]
--pull-on-host: Pull images on host Docker daemon and import them instead of pulling inside the VM. Acts as a pull cache layer.
-f PATH: Set Helm chart values using yaml values file
-v, --verbose: Show verbose output
--help: Show this message and exit.

`agentstack platform stop`

Stop Agent Stack platform. [Local only] Usage:

$ agentstack platform stop [OPTIONS]

Options:

-v, --verbose: Show verbose output
--help: Show this message and exit.

`agentstack platform delete`

Delete Agent Stack platform. [Local only] Usage:

$ agentstack platform delete [OPTIONS]

Options:

-v, --verbose: Show verbose output
--help: Show this message and exit.

`agentstack platform import`

Import a local docker image into the Agent Stack platform. [Local only] Usage:

$ agentstack platform import [OPTIONS] TAG

Arguments:

TAG: Docker image tag to import [required]

Options:

-v, --verbose: Show verbose output
--help: Show this message and exit.

`agentstack platform exec`

For debugging — execute a command inside the Agent Stack platform VM. [Local only] Usage:

$ agentstack platform exec [OPTIONS] [COMMAND]...

Arguments:

[COMMAND]...

Options:

-v, --verbose: Show verbose output
--help: Show this message and exit.

`agentstack client-side-build`

Build agent locally using Docker. [Local only] Usage:

$ agentstack client-side-build [OPTIONS] [CONTEXT]

Arguments:

[CONTEXT]: Docker context for the agent [default: .]

Options:

--dockerfile TEXT: Use custom dockerfile path
--tag TEXT: Docker tag for the agent
--multi-platform / --no-multi-platform: [default: no-multi-platform]
--push / --no-push: Push the image to the target registry. [default: no-push]
--import / --no-import: Import the image into Agent Stack platform [default: import]
-v, --verbose: Show verbose output
--help: Show this message and exit.

`agentstack build`

Build agent from a GitHub repository in the platform. [Admin only] Usage:

$ agentstack build [OPTIONS] GITHUB_URL

Arguments:

GITHUB_URL: Github repository URL (public or private if supported by the platform instance) [required]

Options:

--dockerfile TEXT: Use custom dockerfile path, relative to github url sub-path
-v, --verbose: Show verbose output
-y, --yes: Skip confirmation prompts.
--help: Show this message and exit.

`agentstack server`

Manage Agent Stack servers and authentication. Usage:

$ agentstack server [OPTIONS] COMMAND [ARGS]...

Options:

--help: Show this message and exit.

Commands:

login | change | select | default | switch: Login to a server or switch between logged…
logout | remove | rm | delete
show
list

$ agentstack server login | change | select | default | switch [OPTIONS] [SERVER]

Arguments:

[SERVER]

Options:

--help: Show this message and exit.

`agentstack server logout | remove | rm | delete`

Usage:

$ agentstack server logout | remove | rm | delete [OPTIONS]

Options:

--all / --no-all: [default: no-all]
--help: Show this message and exit.

`agentstack server show`

Usage:

$ agentstack server show [OPTIONS]

Options:

--help: Show this message and exit.

`agentstack server list`

Usage:

$ agentstack server list [OPTIONS]

Options:

--help: Show this message and exit.

`agentstack self`

Manage Agent Stack installation. Usage:

$ agentstack self [OPTIONS] COMMAND [ARGS]...

Options:

--help: Show this message and exit.

Commands:

version: Print version of the Agent Stack CLI.
install: Install Agent Stack platform pre-requisites.
upgrade: Upgrade Agent Stack CLI and Platform to…
uninstall: Uninstall Agent Stack CLI and Platform.

`agentstack self version`

Print version of the Agent Stack CLI. Usage:

$ agentstack self version [OPTIONS]

Options:

-v, --verbose: Show verbose output
--help: Show this message and exit.

`agentstack self install`

Install Agent Stack platform pre-requisites. Usage:

$ agentstack self install [OPTIONS]

Options:

-v, --verbose: Show verbose output
--help: Show this message and exit.

`agentstack self upgrade`

Upgrade Agent Stack CLI and Platform to the latest version. Usage:

$ agentstack self upgrade [OPTIONS]

Options:

-v, --verbose: Show verbose output
--help: Show this message and exit.

`agentstack self uninstall`

Uninstall Agent Stack CLI and Platform. Usage:

$ agentstack self uninstall [OPTIONS]

Options:

-v, --verbose: Show verbose output
--help: Show this message and exit.

`agentstack user`

Manage users. [Admin only] Usage:

$ agentstack user [OPTIONS] COMMAND [ARGS]...

Options:

--help: Show this message and exit.

Commands:

list: List platform users [Admin only]
set-role: Change user role [Admin only]

`agentstack user list`

List platform users [Admin only] Usage:

$ agentstack user list [OPTIONS]

Options:

--email TEXT: Filter by email (case-insensitive partial match)
--limit INTEGER: Results per page (1-100) [default: 40]
--after TEXT: Pagination cursor (page_token)
--help: Show this message and exit.

`agentstack user set-role`

Change user role [Admin only] Usage:

$ agentstack user set-role [OPTIONS] USER_ID ROLE:{admin|developer|user}

Arguments:

USER_ID: User UUID [required]
ROLE:{admin|developer|user}: Target role (admin, developer, user) [required]

Options:

-y, --yes: Skip confirmation prompts.
--help: Show this message and exit.

`agentstack add`

Add a docker image or GitHub repository. [Admin only] This command supports a variety of GitHub URL formats for deploying agents:

Basic URL: https://github.com/myorg/myrepo
Git Protocol URL: git+https://github.com/myorg/myrepo
URL with .git suffix: https://github.com/myorg/myrepo.git
URL with Version Tag: https://github.com/myorg/myrepo@v1.0.0
URL with Branch Name: https://github.com/myorg/myrepo@my-branch
URL with Subfolder Path: https://github.com/myorg/myrepo#path=/path/to/agent
Combined Formats: https://github.com/myorg/myrepo.git@v1.0.0#path=/path/to/agent
Enterprise GitHub: https://github.mycompany.com/myorg/myrepo
With a custom Dockerfile location: agentstack add --dockerfile /my-agent/path/to/Dockerfile "https://github.com/my-org/my-awesome-agents@main#path=/my-agent"

Usage:

$ agentstack add [OPTIONS] [LOCATION]

Arguments:

[LOCATION]: Agent location (public docker image or github url)

Options:

--dockerfile TEXT: Use custom dockerfile path
-v, --verbose: Show verbose output
-y, --yes: Skip confirmation prompts.
--help: Show this message and exit.

`agentstack update`

Upgrade agent to a newer docker image or build from GitHub repository. [Admin only] Usage:

$ agentstack update [OPTIONS] [SEARCH_PATH] [LOCATION]

Arguments:

[SEARCH_PATH]: Short ID, agent name or part of the provider location of agent to replace
[LOCATION]: Agent location (public docker image or github url)

Options:

--dockerfile TEXT: Use custom dockerfile path
-v, --verbose: Show verbose output
-y, --yes: Skip confirmation prompts.
--help: Show this message and exit.

`agentstack remove | uninstall | rm | delete`

Remove agent. [Admin only] Usage:

$ agentstack remove | uninstall | rm | delete [OPTIONS] [SEARCH_PATH]

Arguments:

[SEARCH_PATH]: Short ID, agent name or part of the provider location

Options:

-y, --yes: Skip confirmation prompts.
-a, --all: Remove all agents without selection.
--help: Show this message and exit.

`agentstack logs`

Stream agent provider logs. [Admin only] Usage:

$ agentstack logs [OPTIONS] SEARCH_PATH

Arguments:

SEARCH_PATH: Short ID, agent name or part of the provider location [required]

Options:

--help: Show this message and exit.

`agentstack run`

Run an agent. Usage:

$ agentstack run [OPTIONS] [SEARCH_PATH] [INPUT]

Arguments:

[SEARCH_PATH]: Short ID, agent name or part of the provider location
[INPUT]: Agent input as text or JSON

Options:

--dump-files PATH: Folder path to save any files returned by the agent
--help: Show this message and exit.

`agentstack list`

List agents. Usage:

$ agentstack list [OPTIONS]

Options:

--help: Show this message and exit.

`agentstack info`

Show agent details. Usage:

$ agentstack info [OPTIONS] SEARCH_PATH

Arguments:

SEARCH_PATH: Short ID, agent name or part of the provider location [required]

Options:

--help: Show this message and exit.

`agentstack env`

Usage:

$ agentstack env [OPTIONS] COMMAND [ARGS]...

Options:

--help: Show this message and exit.

Commands:

add: Store environment variables.
list: List stored environment variables.
remove: Remove environment variable(s).

`agentstack env add`

Store environment variables. [Admin only] Usage:

$ agentstack env add [OPTIONS] SEARCH_PATH ENV...

Arguments:

SEARCH_PATH: Short ID, agent name or part of the provider location [required]
ENV...: Environment variables to pass to agent [required]

Options:

-y, --yes: Skip confirmation prompts.
--help: Show this message and exit.

`agentstack env list`

List stored environment variables. [Admin only] Usage:

$ agentstack env list [OPTIONS] SEARCH_PATH

Arguments:

SEARCH_PATH: Short ID, agent name or part of the provider location [required]

Options:

--help: Show this message and exit.

`agentstack env remove`

Remove environment variable(s). [Admin only] Usage:

$ agentstack env remove [OPTIONS] SEARCH_PATH ENV...

Arguments:

SEARCH_PATH: Short ID, agent name or part of the provider location [required]
ENV...: Environment variable(s) to remove [required]

Options:

-y, --yes: Skip confirmation prompts.
--help: Show this message and exit.

`agentstack feedback`

Manage user feedback for your agents Usage:

$ agentstack feedback [OPTIONS] COMMAND [ARGS]...

Options:

--help: Show this message and exit.

Commands:

list: List your agent feedback.

`agentstack feedback list`

List your agent feedback. [Admin only] Usage:

$ agentstack feedback list [OPTIONS] [SEARCH_PATH]

Arguments:

[SEARCH_PATH]: Short ID, agent name or part of the provider location

Options:

--limit INTEGER: Number of results per page [default: 50]
--after TEXT: Cursor for pagination
--help: Show this message and exit.

Introduction

Deploy Agents

Agent Integration

Reference

Deploy Agent Stack

Custom UI Integration

Experimental

Community

​agentstack version

​agentstack ui

​agentstack model

​agentstack model list

​agentstack model setup

​agentstack model change | select | default

​agentstack model add

​agentstack model remove | rm | delete

​agentstack model provider

​agentstack model provider list

​agentstack model provider add

​agentstack model provider remove | rm | delete

​agentstack agent

​agentstack agent add

​agentstack agent update

​agentstack agent remove | uninstall | rm | delete

​agentstack agent logs

​agentstack agent run

​agentstack agent list

​agentstack agent info

​agentstack agent env

​agentstack agent env add

​agentstack agent env list

​agentstack agent env remove

​agentstack agent feedback

​agentstack agent feedback list

​agentstack platform

​agentstack platform start

​agentstack platform stop

​agentstack platform delete

​agentstack platform import

​agentstack platform exec

​agentstack client-side-build

​agentstack build

​agentstack server

​agentstack server login | change | select | default | switch

​agentstack server logout | remove | rm | delete

​agentstack server show

​agentstack server list

​agentstack self

​agentstack self version

​agentstack self install

​agentstack self upgrade

​agentstack self uninstall

​agentstack user

​agentstack user list

​agentstack user set-role

​agentstack add

​agentstack update

​agentstack remove | uninstall | rm | delete

​agentstack logs

​agentstack run

​agentstack list

​agentstack info

​agentstack env

​agentstack env add

​agentstack env list

​agentstack env remove

​agentstack feedback

​agentstack feedback list

`agentstack version`

`agentstack ui`

`agentstack model`

`agentstack model list`

`agentstack model setup`

`agentstack model change | select | default`

`agentstack model add`

`agentstack model remove | rm | delete`

`agentstack model provider`

`agentstack model provider list`

`agentstack model provider add`

`agentstack model provider remove | rm | delete`

`agentstack agent`

`agentstack agent add`

`agentstack agent update`

`agentstack agent remove | uninstall | rm | delete`

`agentstack agent logs`

`agentstack agent run`

`agentstack agent list`

`agentstack agent info`

`agentstack agent env`

`agentstack agent env add`

`agentstack agent env list`

`agentstack agent env remove`

`agentstack agent feedback`

`agentstack agent feedback list`

`agentstack platform`

`agentstack platform start`

`agentstack platform stop`

`agentstack platform delete`

`agentstack platform import`

`agentstack platform exec`

`agentstack client-side-build`

`agentstack build`

`agentstack server`

`agentstack server login | change | select | default | switch`

`agentstack server logout | remove | rm | delete`

`agentstack server show`

`agentstack server list`

`agentstack self`

`agentstack self version`

`agentstack self install`

`agentstack self upgrade`

`agentstack self uninstall`

`agentstack user`

`agentstack user list`

`agentstack user set-role`

`agentstack add`

`agentstack update`

`agentstack remove | uninstall | rm | delete`

`agentstack logs`

`agentstack run`

`agentstack list`

`agentstack info`

`agentstack env`

`agentstack env add`

`agentstack env list`

`agentstack env remove`

`agentstack feedback`

`agentstack feedback list`