Skip to content

Commit 22bf2f4

Browse files
gix-botgix-bot
authored
docs: Update CLI documentation
1 parent 44af861 commit 22bf2f4

File tree

16 files changed

+84
-62
lines changed

16 files changed

+84
-62
lines changed

‎docs/components/subnets.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
1-
| Subnet ID | Type | Canisters (Running/Stopped) | Nodes (Up/Total) |
2-
|-----------|----------------|---------------------|------------------|
3-
| 6pbhf-qzpdk-kuqbr-pklfa-5ehhf-jfjps-zsj6q-57nrl-kzhpd-mu7hc-vae | Juno's Subnet | 34757/68 | 13/13 |
4-
| pzp6e-ekpqk-3c5x7-2h6so-njoeq-mt45d-h3h6c-q3mxf-vpeq5-fk5o7-yae | Fiduciary | 708/7 | 34/34 |
5-
| bkfrj-6k62g-dycql-7h53p-atvkj-zg4to-gaogh-netha-ptybj-ntsgw-rqe | European | 23699/140 | 13/13 |
6-
| 4ecnw-byqwz-dtgss-ua2mh-pfvs7-c3lct-gtf4e-hnu75-j7eek-iifqm-sqe | | 6846/113 | 13/13 |
7-
| 4zbus-z2bmt-ilreg-xakz4-6tyre-hsqj4-slb4g-zjwqo-snjcc-iqphi-3qe | | 1001/1 | 13/13 |
8-
| brlsh-zidhj-3yy3e-6vqbz-7xnih-xeq2l-as5oc-g32c4-i5pdn-2wwof-oae | | 33565/28 | 13/13 |
9-
| cv73p-6v7zi-u67oy-7jc3h-qspsz-g5lrj-4fn7k-xrax3-thek2-sl46v-jae | | 50882/176 | 13/13 |
10-
| e66qm-3cydn-nkf4i-ml4rb-4ro6o-srm5s-x5hwq-hnprz-3meqp-s7vks-5qe | | 35402/98 | 13/13 |
11-
| fuqsr-in2lc-zbcjj-ydmcw-pzq7h-4xm2z-pto4i-dcyee-5z4rz-x63ji-nae | | 19881/0 | 13/13 |
12-
| gmq5v-hbozq-uui6y-o55wc-ihop3-562wb-3qspg-nnijg-npqp5-he3cj-3ae | | 33600/51 | 13/13 |
13-
| io67a-2jmkw-zup3h-snbwi-g6a5n-rm5dn-b6png-lvdpl-nqnto-yih6l-gqe | | 150/2 | 13/13 |
14-
| jtdsg-3h6gi-hs7o5-z2soi-43w3z-soyl3-ajnp3-ekni5-sw553-5kw67-nqe | | 26846/3 | 13/13 |
15-
| lspz2-jx4pu-k3e7p-znm7j-q4yum-ork6e-6w4q6-pijwq-znehu-4jabe-kqe | | 39397/92 | 13/13 |
16-
| pjljw-kztyl-46ud4-ofrj6-nzkhm-3n4nt-wi3jt-ypmav-ijqkt-gjf66-uae | | 31714/62 | 13/13 |
17-
| qdvhd-os4o2-zzrdw-xrcv4-gljou-eztdp-bj326-e6jgr-tkhuc-ql6v2-yqe | | 52456/16 | 13/13 |
1+
| Subnet ID | Type | Canisters (Running/Stopped) | Nodes (Up/Total) |
2+
| --------------------------------------------------------------- | ------------- | --------------------------- | ---------------- |
3+
| 6pbhf-qzpdk-kuqbr-pklfa-5ehhf-jfjps-zsj6q-57nrl-kzhpd-mu7hc-vae | Juno's Subnet | 34757/68 | 13/13 |
4+
| pzp6e-ekpqk-3c5x7-2h6so-njoeq-mt45d-h3h6c-q3mxf-vpeq5-fk5o7-yae | Fiduciary | 708/7 | 34/34 |
5+
| bkfrj-6k62g-dycql-7h53p-atvkj-zg4to-gaogh-netha-ptybj-ntsgw-rqe | European | 23699/140 | 13/13 |
6+
| 4ecnw-byqwz-dtgss-ua2mh-pfvs7-c3lct-gtf4e-hnu75-j7eek-iifqm-sqe | | 6846/113 | 13/13 |
7+
| 4zbus-z2bmt-ilreg-xakz4-6tyre-hsqj4-slb4g-zjwqo-snjcc-iqphi-3qe | | 1001/1 | 13/13 |
8+
| brlsh-zidhj-3yy3e-6vqbz-7xnih-xeq2l-as5oc-g32c4-i5pdn-2wwof-oae | | 33565/28 | 13/13 |
9+
| cv73p-6v7zi-u67oy-7jc3h-qspsz-g5lrj-4fn7k-xrax3-thek2-sl46v-jae | | 50882/176 | 13/13 |
10+
| e66qm-3cydn-nkf4i-ml4rb-4ro6o-srm5s-x5hwq-hnprz-3meqp-s7vks-5qe | | 35402/98 | 13/13 |
11+
| fuqsr-in2lc-zbcjj-ydmcw-pzq7h-4xm2z-pto4i-dcyee-5z4rz-x63ji-nae | | 19881/0 | 13/13 |
12+
| gmq5v-hbozq-uui6y-o55wc-ihop3-562wb-3qspg-nnijg-npqp5-he3cj-3ae | | 33600/51 | 13/13 |
13+
| io67a-2jmkw-zup3h-snbwi-g6a5n-rm5dn-b6png-lvdpl-nqnto-yih6l-gqe | | 150/2 | 13/13 |
14+
| jtdsg-3h6gi-hs7o5-z2soi-43w3z-soyl3-ajnp3-ekni5-sw553-5kw67-nqe | | 26846/3 | 13/13 |
15+
| lspz2-jx4pu-k3e7p-znm7j-q4yum-ork6e-6w4q6-pijwq-znehu-4jabe-kqe | | 39397/92 | 13/13 |
16+
| pjljw-kztyl-46ud4-ofrj6-nzkhm-3n4nt-wi3jt-ypmav-ijqkt-gjf66-uae | | 31714/62 | 13/13 |
17+
| qdvhd-os4o2-zzrdw-xrcv4-gljou-eztdp-bj326-e6jgr-tkhuc-ql6v2-yqe | | 52456/16 | 13/13 |

‎docs/miscellaneous/cli/backup.md

Lines changed: 24 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,29 @@
1-
Handle backup-related tasks.
1+
Unknown command.
22

3-
```bash
4-
Usage: juno dev <subcommand> [options]
3+
---
54

6-
Subcommands:
7-
create Create a backup of your current state.
8-
restore Restore a previously created backup.
9-
delete Delete an existing backup
5+
**) || | || \| |/ \
6+
\_**/ \_**/ |\_|\_\_|\_\_**/ CLI v0.2.15
107

11-
Options:
12-
-t, --target Which module type should be backed up? Valid targets are satellite, mission-control or orbiter.
13-
-m, --mode Set env mode. For example production or a custom string. Default is production.
14-
-h, --help Output usage information.
8+
Usage: juno <command>
159

16-
Notes:
10+
Commands:
11+
clear Clear existing dapp code by removing JavaScript, HTML, CSS, and other files from your satellite.
12+
config Apply configuration to satellite.
13+
deploy Deploy your dapp to your satellite.
14+
dev Handle development tasks like building serverless functions or running a local Internet Computer instance.
15+
init Set up your project.
16+
help Display help information.
17+
login Generate an authentication for use in non-interactive environments.
18+
logout Log out of the current device. ⚠️ This action does not remove controllers from the module.
19+
open Open your satellite in your browser.
20+
snapshot Handle snapshot-related tasks.
21+
start Start a module.
22+
stop Stop a module.
23+
upgrade Upgrade a module to a new version.
24+
use Switch between multiple profiles.
25+
version Check the version of the modules and CLI.
26+
whoami Display your current profile, controller, and links to your satellite.
1727

18-
- Targets can be shortened to s for satellite, m for mission-control and o for orbiter.
19-
```
28+
Options:
29+
--headless Run the CLI in non-interactive mode (enabled automatically if JUNO_TOKEN is set).

‎docs/miscellaneous/cli/clear.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Clear existing dapp code by removing JavaScript, HTML, CSS, and other files from your satellite.
22

3-
```bash
3+
```
44
Usage: juno clear [options]
55
66
Options:

‎docs/miscellaneous/cli/config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Apply configuration to satellite.
22

3-
```bash
3+
```
44
Usage: juno config [options]
55
66
Options:

‎docs/miscellaneous/cli/deploy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Deploy your dapp to your satellite.
22

3-
```bash
3+
```
44
Usage: juno deploy [options]
55
66
Options:

‎docs/miscellaneous/cli/dev.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
Handle development-related tasks such as building and deploying locally using Cargo and Docker.
1+
Handle development tasks like building serverless functions or running a local Internet Computer instance.
22

3-
```bash
4-
Usage: juno dev <subcommand>
3+
```
4+
Usage: juno dev <subcommand> [options]
55
66
Subcommands:
7-
build Compile satellite features using Cargo.
8-
eject Create a Rust template for custom satellite feature hooks and extensions.
9-
start Start a local Internet Computer network, encapsulated in a Docker environment.
10-
stop Stop the Docker environment.
7+
build Build your serverless functions. The local server supports live reloading.
8+
eject Scaffold the necessary files to start coding and building functions in your project.
9+
start Start a local Internet Computer network in a container.
10+
stop Stop the local network.
1111
```

‎docs/miscellaneous/cli/init.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
Set up your project.
22

3-
```bash
3+
```
44
Usage: juno init [options]
55
66
Options:
7+
-m, --minimal Skip few prompts and generate a config file with a placeholder satellite ID.
8+
-m, --mode Set env mode. For example production or a custom string. Default is production.
79
-h, --help Output usage information.
810
```

‎docs/miscellaneous/cli/login.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Generate an authentication for use in non-interactive environments.
22

3-
```bash
3+
```
44
Usage: juno login [options]
55
66
Options:

‎docs/miscellaneous/cli/logout.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Log out of the current device. ⚠️ This action does not remove controllers from the module.
22

3-
```bash
3+
```
44
Usage: juno logout [options]
55
66
Options:

‎docs/miscellaneous/cli/open.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Open your satellite in your browser.
22

3-
```bash
3+
```
44
Usage: juno open [options]
55
66
Options:

‎docs/miscellaneous/cli/upgrade.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
Upgrade a module to a new version.
22

3-
```bash
3+
```
44
Usage: juno upgrade [options]
55
66
Options:
77
-t, --target Which module type should be upgraded? Valid targets are satellite, mission-control or orbiter.
88
-s, --src An optional local gzipped WASM file for the upgrade. By default, the CDN will be used.
99
-r, --reset Reset to the initial state.
1010
-cc, --clear-chunks Clear any previously uploaded WASM chunks (applies if the WASM size is greater than 2MB).
11-
-nb, --no-backup Skip creating a backup before upgrading.
11+
-ns, --no-snapshot Skip creating a snapshot before upgrading.
1212
-m, --mode Set env mode. For example production or a custom string. Default is production.
1313
-h, --help Output usage information.
1414

‎docs/miscellaneous/cli/use.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Switch between multiple profiles.
22

3-
```bash
3+
```
44
Usage: juno use [options]
55
66
Options:

‎docs/miscellaneous/cli/version.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
1-
Check the version of the modules and cli.
1+
Check the version of the modules and CLI.
22

3-
```bash
4-
Usage: juno version [options]
3+
```
4+
Usage: juno init [options]
55
66
Options:
7-
-h, --help Output usage information.
7+
-c, --cli Check only the version of the CLI.
88
-m, --mode Set env mode. For example production or a custom string. Default is production.
9+
-h, --help Output usage information.
910
```

‎docs/miscellaneous/cli/whoami.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Display your current profile, controller, and links to your satellite.
22

3-
```bash
3+
```
44
Usage: juno whoami [options]
55
66
Options:

‎showcase.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
"url": "https://m5rwi-daaaa-aaaal-acrpq-cai.icp0.io",
3636
"description": "An adventure around the world to meet great souls and promote good stuff.",
3737
"img": "/showcase/aegir.jpg",
38-
"github":"https://github.com/Kyliux/Icloud"
38+
"github": "https://github.com/Kyliux/Icloud"
3939
},
4040
{
4141
"title": "ICPFA",

‎src/components/Spotlight/index.tsx

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,23 @@ export default function Spotlight({
2323
</div>
2424

2525
<div className={styles.content}>
26-
<h4>
27-
{title}
28-
{github && (
29-
<Link href={github} target="_blank" rel="noreferrer noopener nofollow" className={styles.githubLink}>
30-
<img src="https://upload.wikimedia.org/wikipedia/commons/thumb/a/ae/Github-desktop-logo-symbol.svg/640px-Github-desktop-logo-symbol.svg.png" alt="GitHub Logo" className={styles.githubLogo} />
31-
</Link>
32-
)}
33-
</h4>
26+
<h4>
27+
{title}
28+
{github && (
29+
<Link
30+
href={github}
31+
target="_blank"
32+
rel="noreferrer noopener nofollow"
33+
className={styles.githubLink}
34+
>
35+
<img
36+
src="https://upload.wikimedia.org/wikipedia/commons/thumb/a/ae/Github-desktop-logo-symbol.svg/640px-Github-desktop-logo-symbol.svg.png"
37+
alt="GitHub Logo"
38+
className={styles.githubLogo}
39+
/>
40+
</Link>
41+
)}
42+
</h4>
3443
<p>{description}</p>
3544
</div>
3645
</article>

0 commit comments

Comments
 (0)