Skip to content

Commit 70f92a5

Browse files
docs: re-index chapters in the CLI references (more flat approach) (#525)
* docs: re-index chapters in the CLI reference (more flat approach) Signed-off-by: David Dal Busco <david.dalbusco@outlook.com> * 📄 Update LLMs.txt snapshot for PR review --------- Signed-off-by: David Dal Busco <david.dalbusco@outlook.com> Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
1 parent c666a70 commit 70f92a5

2 files changed

Lines changed: 66 additions & 78 deletions

File tree

.llms-snapshots/llms-full.txt

Lines changed: 34 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -7603,9 +7603,9 @@ npm i -g @junobuild/cli
76037603

76047604
---
76057605

7606-
## Administration
7606+
## Commands
76077607

7608-
Commands dedicated to configuring and managing deployed Satellites, Mission Control, and other modules.
7608+
The following is a complete list of commands available in the Juno CLI.
76097609

76107610
**Tip:**
76117611

@@ -7683,6 +7683,20 @@ Usage: juno deploy [options]Options: --batch Number of files to u
76837683

76847684
---
76857685

7686+
### Clear
7687+
7688+
Clear existing app code by removing JavaScript, HTML, CSS, and other files from your satellite.
7689+
7690+
```
7691+
Usage: juno clear [options]Options: -f, --fullPath Clear a particular file of your app. -m, --mode Choose which environment to use (production, staging, development). Defaults to production if omitted. -p, --profile Specify an optional profile to use (e.g. personal, team). Useful when managing multiple Mission Controls. --container-url Override a custom container URL. If not provided, defaults to production or the local container in development mode. --console-url Specify a custom URL to access the developer Console. -h, --help Output usage information.
7692+
```
7693+
7694+
**Note:**
7695+
7696+
This command removes existing files from the satellite and only affects the app assets. The user's uploaded files will not be cleared as the app is deployed to a reserved collection, `#dapp`.
7697+
7698+
---
7699+
76867700
### Config
76877701

76887702
Apply configuration to satellite.
@@ -7723,20 +7737,6 @@ Usage: juno start [options]Options: -t, --target Which module type sho
77237737

77247738
---
77257739

7726-
### Clear
7727-
7728-
Clear existing app code by removing JavaScript, HTML, CSS, and other files from your satellite.
7729-
7730-
```
7731-
Usage: juno clear [options]Options: -f, --fullPath Clear a particular file of your app. -m, --mode Choose which environment to use (production, staging, development). Defaults to production if omitted. -p, --profile Specify an optional profile to use (e.g. personal, team). Useful when managing multiple Mission Controls. --container-url Override a custom container URL. If not provided, defaults to production or the local container in development mode. --console-url Specify a custom URL to access the developer Console. -h, --help Output usage information.
7732-
```
7733-
7734-
**Note:**
7735-
7736-
This command removes existing files from the satellite and only affects the app assets. The user's uploaded files will not be cleared as the app is deployed to a reserved collection, `#dapp`.
7737-
7738-
---
7739-
77407740
### Upgrade
77417741

77427742
Upgrade a module to a new version.
@@ -7754,7 +7754,7 @@ The CLI automatically runs in non-interactive mode if either a JUNO\_TOKEN is se
77547754

77557755
---
77567756

7757-
## Changes
7757+
### Changes
77587758

77597759
Review and apply changes submitted to your module.
77607760

@@ -7764,7 +7764,7 @@ Usage: juno changes <subcommand> [options]Subcommands: apply Appl
77647764

77657765
---
77667766

7767-
### Apply
7767+
#### Apply
77687768

77697769
Apply a submitted change.
77707770

@@ -7774,7 +7774,7 @@ Usage: juno changes apply [options]Options: -i, --id The ID of the
77747774

77757775
---
77767776

7777-
### List
7777+
#### List
77787778

77797779
List all submitted or applied changes.
77807780

@@ -7784,7 +7784,7 @@ Usage: juno changes list [options]Options: -a, --all Search through a
77847784

77857785
---
77867786

7787-
### Reject
7787+
#### Reject
77887788

77897789
Reject a change.
77907790

@@ -7794,7 +7794,7 @@ Usage: juno changes reject [options]Options: -i, --id The ID of th
77947794

77957795
---
77967796

7797-
## Emulator
7797+
### Emulator
77987798

77997799
Handle developer tasks like starting/stopping a local network.
78007800

@@ -7804,7 +7804,7 @@ Usage: juno dev <subcommand> [options]Subcommands: start Start a
78047804

78057805
---
78067806

7807-
### Start
7807+
#### Start
78087808

78097809
Start a local Internet Computer network in a container.
78107810

@@ -7814,7 +7814,7 @@ Usage: juno dev start [options]Options: -l, --lang Specify the langu
78147814

78157815
---
78167816

7817-
### Wait
7817+
#### Wait
78187818

78197819
Wait until the emulator is ready.
78207820

@@ -7824,7 +7824,7 @@ Usage: juno dev wait [options]Options: -t, --timeout Timeout for the em
78247824

78257825
---
78267826

7827-
## Functions
7827+
### Functions
78287828

78297829
Build and upgrade your satellite's serverless functions.
78307830

@@ -7834,17 +7834,7 @@ Usage: juno functions <subcommand> [options]Subcommands: build B
78347834

78357835
---
78367836

7837-
## Run
7838-
7839-
Run a custom script in the CLI context.
7840-
7841-
```
7842-
Usage: juno run [options]Options: -s, --src The path to your JavaScript or TypeScript script. -m, --mode Choose which environment to use (production, staging, development). Defaults to production if omitted. -p, --profile Specify an optional profile to use (e.g. personal, team). Useful when managing multiple Mission Controls. --container-url Override a custom container URL. If not provided, defaults to production or the local container in development mode. -h, --help Output usage information.
7843-
```
7844-
7845-
---
7846-
7847-
### Build
7837+
#### Build
78487838

78497839
Build your serverless functions.
78507840

@@ -7854,7 +7844,7 @@ Usage: juno functions build [options]Options: -l, --lang Specify the
78547844

78557845
---
78567846

7857-
### Eject
7847+
#### Eject
78587848

78597849
Generate the required files to begin developing serverless functions in your project.
78607850

@@ -7864,7 +7854,7 @@ Usage: juno functions eject [options]Options: -l, --lang Specify the
78647854

78657855
---
78667856

7867-
### Publish
7857+
#### Publish
78687858

78697859
Publish a new version of your serverless functions.
78707860

@@ -7874,7 +7864,7 @@ Usage: juno functions publish [options]Options: --no-apply Submit th
78747864

78757865
---
78767866

7877-
### Upgrade
7867+
#### Upgrade
78787868

78797869
Upgrade your serverless functions.
78807870

@@ -7884,9 +7874,13 @@ Usage: juno functions upgrade [options]Options: --cdn Select a
78847874

78857875
---
78867876

7887-
## Others
7877+
### Run
78887878

7889-
Additional commands for managing and interacting with the CLI environment.
7879+
Run a custom script in the CLI context.
7880+
7881+
```
7882+
Usage: juno run [options]Options: -s, --src The path to your JavaScript or TypeScript script. -m, --mode Choose which environment to use (production, staging, development). Defaults to production if omitted. -p, --profile Specify an optional profile to use (e.g. personal, team). Useful when managing multiple Mission Controls. --container-url Override a custom container URL. If not provided, defaults to production or the local container in development mode. -h, --help Output usage information.
7883+
```
78907884

78917885
---
78927886

docs/reference/cli.mdx

Lines changed: 32 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@ npm i -g @junobuild/cli
2727

2828
---
2929

30-
## Administration
30+
## Commands
3131

32-
Commands dedicated to configuring and managing deployed Satellites, Mission Control, and other modules.
32+
The following is a complete list of commands available in the Juno CLI.
3333

3434
:::tip
3535

@@ -107,6 +107,20 @@ import Deploy from "./cli/deploy.md";
107107

108108
---
109109

110+
### Clear
111+
112+
import Clear from "./cli/clear.md";
113+
114+
<Clear />
115+
116+
:::note
117+
118+
This command removes existing files from the satellite and only affects the app assets. The user's uploaded files will not be cleared as the app is deployed to a reserved collection, `#dapp`.
119+
120+
:::
121+
122+
---
123+
110124
### Config
111125

112126
import Config from "./cli/config.md";
@@ -139,20 +153,6 @@ import Start from "./cli/start.md";
139153

140154
---
141155

142-
### Clear
143-
144-
import Clear from "./cli/clear.md";
145-
146-
<Clear />
147-
148-
:::note
149-
150-
This command removes existing files from the satellite and only affects the app assets. The user's uploaded files will not be cleared as the app is deployed to a reserved collection, `#dapp`.
151-
152-
:::
153-
154-
---
155-
156156
### Upgrade
157157

158158
import Upgrade from "./cli/upgrade.md";
@@ -170,113 +170,107 @@ The CLI automatically runs in non-interactive mode if either a JUNO_TOKEN is set
170170

171171
---
172172

173-
## Changes
173+
### Changes
174174

175175
import Changes from "./cli/changes.md";
176176

177177
<Changes />
178178

179179
---
180180

181-
### Apply
181+
#### Apply
182182

183183
import ChangesApply from "./cli/changes-apply.md";
184184

185185
<ChangesApply />
186186

187187
---
188188

189-
### List
189+
#### List
190190

191191
import ChangesList from "./cli/changes-list.md";
192192

193193
<ChangesList />
194194

195195
---
196196

197-
### Reject
197+
#### Reject
198198

199199
import ChangesReject from "./cli/changes-reject.md";
200200

201201
<ChangesReject />
202202

203203
---
204204

205-
## Emulator
205+
### Emulator
206206

207207
import Emulator from "./cli/emulator.md";
208208

209209
<Emulator />
210210

211211
---
212212

213-
### Start
213+
#### Start
214214

215215
import EmulatorStart from "./cli/emulator-start.md";
216216

217217
<EmulatorStart />
218218

219219
---
220220

221-
### Wait
221+
#### Wait
222222

223223
import EmulatorWait from "./cli/emulator-wait.md";
224224

225225
<EmulatorWait />
226226

227227
---
228228

229-
## Functions
229+
### Functions
230230

231231
import Functions from "./cli/functions.md";
232232

233233
<Functions />
234234

235235
---
236236

237-
## Run
238-
239-
import Run from "./cli/run.md";
240-
241-
<Run />
242-
243-
---
244-
245-
### Build
237+
#### Build
246238

247239
import FunctionsBuild from "./cli/functions-build.md";
248240

249241
<FunctionsBuild />
250242

251243
---
252244

253-
### Eject
245+
#### Eject
254246

255247
import FunctionsEject from "./cli/functions-eject.md";
256248

257249
<FunctionsEject />
258250

259251
---
260252

261-
### Publish
253+
#### Publish
262254

263255
import FunctionsPublish from "./cli/functions-publish.md";
264256

265257
<FunctionsPublish />
266258

267259
---
268260

269-
### Upgrade
261+
#### Upgrade
270262

271263
import FunctionsUpgrade from "./cli/functions-upgrade.md";
272264

273265
<FunctionsUpgrade />
274266

275267
---
276268

277-
## Others
269+
### Run
278270

279-
Additional commands for managing and interacting with the CLI environment.
271+
import Run from "./cli/run.md";
272+
273+
<Run />
280274

281275
---
282276

0 commit comments

Comments
 (0)