Skip to content

Commit c967008

Browse files
docs: add juno snapshot upload to CLI (#547)
* docs: juno snapshot upload to CLI 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 26fe704 commit c967008

4 files changed

Lines changed: 43 additions & 0 deletions

File tree

.llms-snapshots/llms-full.txt

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7765,6 +7765,16 @@ Usage: juno snapshot <subcommand> [options]Subcommands: create Cr
77657765

77667766
---
77677767

7768+
### Upload
7769+
7770+
Upload a snapshot from offline files.
7771+
7772+
```
7773+
Usage: juno snapshot upload [options]Options: --dir Path to the snapshot directory that contains the metadata.json and chunks. -t, --target Which module type should be snapshotted? Valid targets are satellite, mission-control or orbiter. --target-id The module ID of a specific target to upload the snapshot to. -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.Notes:- Targets can be shortened to s for satellite, m for mission-control and o for orbiter.
7774+
```
7775+
7776+
---
7777+
77687778
### Stop
77697779

77707780
Stop a module.

docs/reference/cli.mdx

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,14 @@ import Snapshot from "./cli/snapshot.md";
153153

154154
---
155155

156+
### Upload
157+
158+
import SnapshotUpload from "./cli/snapshot-upload.md";
159+
160+
<SnapshotUpload />
161+
162+
---
163+
156164
### Stop
157165

158166
import Stop from "./cli/stop.md";
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
Upload a snapshot from offline files.
2+
3+
```
4+
Usage: juno snapshot upload [options]
5+
6+
Options:
7+
--dir Path to the snapshot directory that contains the metadata.json and chunks.
8+
-t, --target Which module type should be snapshotted? Valid targets are satellite, mission-control or orbiter.
9+
--target-id The module ID of a specific target to upload the snapshot to.
10+
-m, --mode Choose which environment to use (production, staging, development). Defaults to production if omitted.
11+
-p, --profile Specify an optional profile to use (e.g. personal, team). Useful when managing multiple Mission Controls.
12+
--container-url Override a custom container URL. If not provided, defaults to production or the local container in development mode.
13+
--console-url Specify a custom URL to access the developer Console.
14+
-h, --help Output usage information.
15+
16+
Notes:
17+
18+
- Targets can be shortened to s for satellite, m for mission-control and o for orbiter.
19+
```

scripts/cli-to-md.sh

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,4 +43,10 @@ for cmd in $(echo $CONFIG_COMMANDS | sed "s/,/ /g"); do
4343
generate_command_markdown "config $cmd"
4444
done
4545

46+
EMULATOR_COMMANDS=upload
47+
48+
for cmd in $(echo $EMULATOR_COMMANDS | sed "s/,/ /g"); do
49+
generate_command_markdown "snapshot $cmd"
50+
done
51+
4652
npm run format

0 commit comments

Comments
 (0)