Skip to content
This repository was archived by the owner on Sep 30, 2025. It is now read-only.

Commit 28fcec0

Browse files
committed
chore: regenerated CLI.md
1 parent ab76b17 commit 28fcec0

File tree

1 file changed

+44
-22
lines changed

1 file changed

+44
-22
lines changed

CLI.md

Lines changed: 44 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -39,22 +39,42 @@ $ dreadnode agent [OPTIONS] COMMAND [ARGS]...
3939

4040
**Commands**:
4141

42-
* `deploy`: Start a new run using the latest agent...
42+
* `clone`: Clone a github repository
43+
* `deploy`: Start a new run using the latest active...
4344
* `init`: Initialize a new agent project
44-
* `latest`: Show the latest run of the currently...
45-
* `links`: List all available links
45+
* `latest`: Show the latest run of the active agent
46+
* `links`: List available agent links
4647
* `models`: List available models for the current (or...
47-
* `push`: Push a new version of the agent.
48-
* `runs`: List all runs for the currently active agent
49-
* `show`: Show the status of the currently active agent
50-
* `strikes`: List all strikes
51-
* `switch`: Switch/link to a different agent
52-
* `templates`: List all available templates with their...
53-
* `versions`: List historical versions of this agent
48+
* `push`: Push a new version of the active agent
49+
* `runs`: List runs for the active agent
50+
* `show`: Show the status of the active agent
51+
* `strikes`: List available strikes
52+
* `switch`: Switch to a different agent link
53+
* `templates`: List available agent templates with their...
54+
* `versions`: List historical versions of the active agent
55+
56+
### `dreadnode agent clone`
57+
58+
Clone a github repository
59+
60+
**Usage**:
61+
62+
```console
63+
$ dreadnode agent clone [OPTIONS] REPO [TARGET]
64+
```
65+
66+
**Arguments**:
67+
68+
* `REPO`: Repository name or URL [required]
69+
* `[TARGET]`: The target directory
70+
71+
**Options**:
72+
73+
* `--help`: Show this message and exit.
5474

5575
### `dreadnode agent deploy`
5676

57-
Start a new run using the latest agent version
77+
Start a new run using the latest active agent version
5878

5979
**Usage**:
6080

@@ -90,11 +110,12 @@ $ dreadnode agent init [OPTIONS] STRIKE
90110
* `-n, --name TEXT`: The project name (used for container naming)
91111
* `-t, --template [rigging_basic|rigging_loop|nerve_basic]`: The template to use for the agent [default: rigging_basic]
92112
* `-s, --source TEXT`: Initialize the agent using a custom template from a github repository, ZIP archive URL or local folder
113+
* `-p, --path TEXT`: If --source has been provided, use --path to specify a subfolder to initialize from
93114
* `--help`: Show this message and exit.
94115

95116
### `dreadnode agent latest`
96117

97-
Show the latest run of the currently active agent
118+
Show the latest run of the active agent
98119

99120
**Usage**:
100121

@@ -112,7 +133,7 @@ $ dreadnode agent latest [OPTIONS]
112133

113134
### `dreadnode agent links`
114135

115-
List all available links
136+
List available agent links
116137

117138
**Usage**:
118139

@@ -149,7 +170,7 @@ $ dreadnode agent models [OPTIONS] [DIRECTORY]
149170

150171
### `dreadnode agent push`
151172

152-
Push a new version of the agent.
173+
Push a new version of the active agent
153174

154175
**Usage**:
155176

@@ -164,11 +185,12 @@ $ dreadnode agent push [OPTIONS]
164185
* `-e, --env-var TEXT`: Environment vars to use when executing the image (key=value)
165186
* `-n, --new`: Create a new agent instead of a new version
166187
* `-m, --message TEXT`: Notes for the new version
188+
* `-r, --rebuild`: Force rebuild the agent image
167189
* `--help`: Show this message and exit.
168190

169191
### `dreadnode agent runs`
170192

171-
List all runs for the currently active agent
193+
List runs for the active agent
172194

173195
**Usage**:
174196

@@ -186,7 +208,7 @@ $ dreadnode agent runs [OPTIONS] [DIRECTORY]
186208

187209
### `dreadnode agent show`
188210

189-
Show the status of the currently active agent
211+
Show the status of the active agent
190212

191213
**Usage**:
192214

@@ -201,7 +223,7 @@ $ dreadnode agent show [OPTIONS]
201223

202224
### `dreadnode agent strikes`
203225

204-
List all strikes
226+
List available strikes
205227

206228
**Usage**:
207229

@@ -215,17 +237,17 @@ $ dreadnode agent strikes [OPTIONS]
215237

216238
### `dreadnode agent switch`
217239

218-
Switch/link to a different agent
240+
Switch to a different agent link
219241

220242
**Usage**:
221243

222244
```console
223-
$ dreadnode agent switch [OPTIONS] AGENT [DIRECTORY]
245+
$ dreadnode agent switch [OPTIONS] AGENT_OR_PROFILE [DIRECTORY]
224246
```
225247

226248
**Arguments**:
227249

228-
* `AGENT`: Agent key or id [required]
250+
* `AGENT_OR_PROFILE`: Agent key/id or profile name [required]
229251
* `[DIRECTORY]`: The agent directory [default: .]
230252

231253
**Options**:
@@ -234,7 +256,7 @@ $ dreadnode agent switch [OPTIONS] AGENT [DIRECTORY]
234256

235257
### `dreadnode agent templates`
236258

237-
List all available templates with their descriptions
259+
List available agent templates with their descriptions
238260

239261
**Usage**:
240262

@@ -248,7 +270,7 @@ $ dreadnode agent templates [OPTIONS]
248270

249271
### `dreadnode agent versions`
250272

251-
List historical versions of this agent
273+
List historical versions of the active agent
252274

253275
**Usage**:
254276

0 commit comments

Comments
 (0)