Skip to content

Commit efb036f

Browse files
committed
docs: generate CLI docs
Signed-off-by: Jan Pokorný <JenomPokorny@gmail.com>
1 parent 9695673 commit efb036f

2 files changed

Lines changed: 58 additions & 63 deletions

File tree

apps/agentstack-cli/tasks.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,6 @@ GEN_TMP=$(mktemp)
164164
trap 'rm -f $HEAD_TMP $GEN_TMP' EXIT
165165
166166
cat $CLI_REFERENCE | sed "/usage-generator/q" > $HEAD_TMP
167-
uv run typer $TYPER_SCRIPT utils docs --name agentstack | tail -n +2 > $GEN_TMP
167+
uv run -m typer $TYPER_SCRIPT utils docs --name agentstack | tail -n +2 > $GEN_TMP
168168
cat $HEAD_TMP $GEN_TMP > $CLI_REFERENCE
169169
'''

docs/development/reference/cli-reference.mdx

Lines changed: 57 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,6 @@ $ agentstack [OPTIONS] COMMAND [ARGS]...
3838
* `build`: Build agent from a GitHub repository in...
3939
* `server`: Manage Agent Stack servers and...
4040
* `self`: Manage Agent Stack installation.
41-
* `user`: Manage users.
4241
* `add`: Add a docker image or GitHub repository.
4342
* `update`: Upgrade agent to a newer docker image or...
4443
* `remove | uninstall | rm | delete`: Remove agent.
@@ -128,6 +127,28 @@ $ agentstack model setup [OPTIONS]
128127
**Options**:
129128

130129
* `-v, --verbose`: Show verbose output
130+
* `--llm-provider TEXT`: LLM provider type (e.g. openai, anthropic, watsonx)
131+
* `--llm-api-key TEXT`: LLM provider API key
132+
* `--llm-base-url TEXT`: Base URL for &#x27;other&#x27; LLM provider
133+
* `--llm-watsonx-region TEXT`: IBM watsonx region for LLM (e.g. us-south)
134+
* `--llm-watsonx-project-or-space TEXT`: IBM watsonx: &#x27;project&#x27; or &#x27;space&#x27;
135+
* `--llm-watsonx-project-or-space-id TEXT`: IBM watsonx project or space ID for LLM
136+
* `--llm-model TEXT`: Default LLM model ID (e.g. openai:gpt-4o)
137+
* `--llm-bedrock-region TEXT`: AWS region for Bedrock LLM (e.g. us-east-1)
138+
* `--llm-bedrock-access-key TEXT`: AWS Access Key ID for Bedrock LLM
139+
* `--llm-bedrock-secret-key TEXT`: AWS Secret Access Key for Bedrock LLM
140+
* `--embedding-provider TEXT`: Embedding provider type (e.g. openai, watsonx)
141+
* `--embedding-api-key TEXT`: Embedding provider API key
142+
* `--embedding-base-url TEXT`: Base URL for &#x27;other&#x27; embedding provider
143+
* `--embedding-watsonx-region TEXT`: IBM watsonx region for embedding
144+
* `--embedding-watsonx-project-or-space TEXT`: IBM watsonx: &#x27;project&#x27; or &#x27;space&#x27;
145+
* `--embedding-watsonx-project-or-space-id TEXT`: IBM watsonx project or space ID for embedding
146+
* `--embedding-model TEXT`: Default embedding model ID
147+
* `--embedding-bedrock-region TEXT`: AWS region for Bedrock embedding (e.g. us-east-1)
148+
* `--embedding-bedrock-access-key TEXT`: AWS Access Key ID for Bedrock embedding
149+
* `--embedding-bedrock-secret-key TEXT`: AWS Secret Access Key for Bedrock embedding
150+
* `--skip-embedding`: Skip embedding provider setup
151+
* `-y, --yes`: Skip confirmation prompts and auto-select recommended models
131152
* `--help`: Show this message and exit.
132153

133154
### `agentstack model change | select | default`
@@ -166,6 +187,17 @@ $ agentstack model add [OPTIONS] [CAPABILITY]:[llm|embedding]
166187

167188
**Options**:
168189

190+
* `--provider TEXT`: Provider type (e.g. openai, anthropic, watsonx)
191+
* `--api-key TEXT`: Provider API key
192+
* `--base-url TEXT`: Base URL for &#x27;other&#x27; provider
193+
* `--watsonx-region TEXT`: IBM watsonx region
194+
* `--watsonx-project-or-space TEXT`: IBM watsonx: &#x27;project&#x27; or &#x27;space&#x27;
195+
* `--watsonx-project-or-space-id TEXT`: IBM watsonx project or space ID
196+
* `--bedrock-region TEXT`: AWS region for Bedrock (e.g. us-east-1)
197+
* `--bedrock-access-key TEXT`: AWS Access Key ID for Bedrock
198+
* `--bedrock-secret-key TEXT`: AWS Secret Access Key for Bedrock
199+
* `--model TEXT`: Default model ID to use after adding the provider
200+
* `-y, --yes`: Skip confirmation prompts and auto-select recommended model
169201
* `--help`: Show this message and exit.
170202

171203
### `agentstack model remove | rm | delete`
@@ -233,6 +265,17 @@ $ agentstack model provider add [OPTIONS] [CAPABILITY]:[llm|embedding]
233265

234266
**Options**:
235267

268+
* `--provider TEXT`: Provider type (e.g. openai, anthropic, watsonx)
269+
* `--api-key TEXT`: Provider API key
270+
* `--base-url TEXT`: Base URL for &#x27;other&#x27; provider
271+
* `--watsonx-region TEXT`: IBM watsonx region
272+
* `--watsonx-project-or-space TEXT`: IBM watsonx: &#x27;project&#x27; or &#x27;space&#x27;
273+
* `--watsonx-project-or-space-id TEXT`: IBM watsonx project or space ID
274+
* `--bedrock-region TEXT`: AWS region for Bedrock (e.g. us-east-1)
275+
* `--bedrock-access-key TEXT`: AWS Access Key ID for Bedrock
276+
* `--bedrock-secret-key TEXT`: AWS Secret Access Key for Bedrock
277+
* `--model TEXT`: Default model ID to use after adding the provider
278+
* `-y, --yes`: Skip confirmation prompts and auto-select recommended model
236279
* `--help`: Show this message and exit.
237280

238281
#### `agentstack model provider remove | rm | delete`
@@ -724,12 +767,13 @@ $ agentstack platform start [OPTIONS]
724767
**Options**:
725768

726769
* `--set TEXT`: Set Helm chart values using &lt;key&gt;=&lt;value&gt; syntax [default: &lt;class &#x27;list&#x27;&gt;]
727-
* `--image-pull-mode <guest|host|hybrid>`:
728-
* `guest`: Pull all images inside VM
729-
* `host`: Pull unavailable images on host, then import all
730-
* `hybrid`: Import available images from host, pull the rest in VM
731-
* `skip`: Skip explicit pull step (Kubernetes will attempt to pull missing images)
770+
* `--image-pull-mode [guest|host|hybrid|skip]`: guest = pull all images inside VM
771+
<span style="color: #000000; text-decoration-color: #000000">host = pull unavailable images on host, then import all</span>
772+
<span style="color: #000000; text-decoration-color: #000000">hybrid = import available images from host, pull the rest in VM</span>
773+
<span style="color: #000000; text-decoration-color: #000000">skip = skip explicit pull step (Kubernetes will attempt to pull missing images) [default: guest]</span>
732774
* `-f PATH`: Set Helm chart values using yaml values file
775+
* `--lima-image TEXT`: Local path or URL to Lima image (.qcow2)
776+
* `--wsl-image TEXT`: Local path or URL to WSL distro image (.wsl)
733777
* `-v, --verbose`: Show verbose output
734778
* `--help`: Show this message and exit.
735779

@@ -780,6 +824,7 @@ $ agentstack platform import [OPTIONS] TAG
780824
**Options**:
781825

782826
* `-v, --verbose`: Show verbose output
827+
* `--mode [daemon|registry]`: [default: daemon]
783828
* `--help`: Show this message and exit.
784829

785830
### `agentstack platform exec`
@@ -822,6 +867,7 @@ $ agentstack client-side-build [OPTIONS] [CONTEXT]
822867
* `--multi-platform / --no-multi-platform`: [default: no-multi-platform]
823868
* `--push / --no-push`: Push the image to the target registry. [default: no-push]
824869
* `--import / --no-import`: Import the image into Agent Stack platform [default: import]
870+
* `--extract-agent-card / --no-extract-agent-card`: Extract agent card from running container [default: extract-agent-card]
825871
* `-v, --verbose`: Show verbose output
826872
* `--help`: Show this message and exit.
827873

@@ -883,6 +929,9 @@ $ agentstack server login | change | select | default | switch [OPTIONS] [SERVER
883929

884930
**Options**:
885931

932+
* `--client-id TEXT`: OAuth client ID (skips interactive prompt)
933+
* `--client-secret TEXT`: OAuth client secret (skips interactive prompt)
934+
* `--auth-server TEXT`: Authorization server URL (skips interactive selection)
886935
* `--help`: Show this message and exit.
887936

888937
### `agentstack server logout | remove | rm | delete`
@@ -971,6 +1020,7 @@ $ agentstack self install [OPTIONS]
9711020
**Options**:
9721021

9731022
* `-v, --verbose`: Show verbose output
1023+
* `-y, --yes`: Skip confirmation prompts
9741024
* `--help`: Show this message and exit.
9751025

9761026
### `agentstack self upgrade`
@@ -1003,62 +1053,6 @@ $ agentstack self uninstall [OPTIONS]
10031053
* `-v, --verbose`: Show verbose output
10041054
* `--help`: Show this message and exit.
10051055

1006-
## `agentstack user`
1007-
1008-
Manage users. [Admin only]
1009-
1010-
**Usage**:
1011-
1012-
```console
1013-
$ agentstack user [OPTIONS] COMMAND [ARGS]...
1014-
```
1015-
1016-
**Options**:
1017-
1018-
* `--help`: Show this message and exit.
1019-
1020-
**Commands**:
1021-
1022-
* `list`: List platform users [Admin only]
1023-
* `set-role`: Change user role [Admin only]
1024-
1025-
### `agentstack user list`
1026-
1027-
List platform users [Admin only]
1028-
1029-
**Usage**:
1030-
1031-
```console
1032-
$ agentstack user list [OPTIONS]
1033-
```
1034-
1035-
**Options**:
1036-
1037-
* `--email TEXT`: Filter by email (case-insensitive partial match)
1038-
* `--limit INTEGER`: Results per page (1-100) [default: 40]
1039-
* `--after TEXT`: Pagination cursor (page_token)
1040-
* `--help`: Show this message and exit.
1041-
1042-
### `agentstack user set-role`
1043-
1044-
Change user role [Admin only]
1045-
1046-
**Usage**:
1047-
1048-
```console
1049-
$ agentstack user set-role [OPTIONS] USER_ID ROLE:{admin|developer|user}
1050-
```
1051-
1052-
**Arguments**:
1053-
1054-
* `USER_ID`: User UUID [required]
1055-
* `ROLE:{admin|developer|user}`: Target role (admin, developer, user) [required]
1056-
1057-
**Options**:
1058-
1059-
* `-y, --yes`: Skip confirmation prompts.
1060-
* `--help`: Show this message and exit.
1061-
10621056
## `agentstack add`
10631057

10641058
Add a docker image or GitHub repository. [Admin only]
@@ -1317,3 +1311,4 @@ $ agentstack feedback list [OPTIONS] [SEARCH_PATH]
13171311
* `--limit INTEGER`: Number of results per page [default: 50]
13181312
* `--after TEXT`: Cursor for pagination
13191313
* `--help`: Show this message and exit.
1314+

0 commit comments

Comments
 (0)