Skip to content

docs: Update CLI documentation #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

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

```bash
Usage: juno dev <subcommand> [options]
---

Subcommands:
create Create a backup of your current state.
restore Restore a previously created backup.
delete Delete an existing backup
**) || | || \| |/ \
\_**/ \_**/ |\_|\_\_|\_\_**/ CLI v0.2.15

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

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

- Targets can be shortened to s for satellite, m for mission-control and o for orbiter.
```
Options:
--headless Run the CLI in non-interactive mode (enabled automatically if JUNO_TOKEN is set).
2 changes: 1 addition & 1 deletion docs/miscellaneous/cli/clear.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Clear existing dapp code by removing JavaScript, HTML, CSS, and other files from your satellite.

```bash
```
Usage: juno clear [options]

Options:
Expand Down
2 changes: 1 addition & 1 deletion docs/miscellaneous/cli/config.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Apply configuration to satellite.

```bash
```
Usage: juno config [options]

Options:
Expand Down
2 changes: 1 addition & 1 deletion docs/miscellaneous/cli/deploy.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Deploy your dapp to your satellite.

```bash
```
Usage: juno deploy [options]

Options:
Expand Down
14 changes: 7 additions & 7 deletions docs/miscellaneous/cli/dev.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
Handle development-related tasks such as building and deploying locally using Cargo and Docker.
Handle development tasks like building serverless functions or running a local Internet Computer instance.

```bash
Usage: juno dev <subcommand>
```
Usage: juno dev <subcommand> [options]

Subcommands:
build Compile satellite features using Cargo.
eject Create a Rust template for custom satellite feature hooks and extensions.
start Start a local Internet Computer network, encapsulated in a Docker environment.
stop Stop the Docker environment.
build Build your serverless functions. The local server supports live reloading.
eject Scaffold the necessary files to start coding and building functions in your project.
start Start a local Internet Computer network in a container.
stop Stop the local network.
```
4 changes: 3 additions & 1 deletion docs/miscellaneous/cli/init.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
Set up your project.

```bash
```
Usage: juno init [options]

Options:
-m, --minimal Skip few prompts and generate a config file with a placeholder satellite ID.
-m, --mode Set env mode. For example production or a custom string. Default is production.
-h, --help Output usage information.
```
2 changes: 1 addition & 1 deletion docs/miscellaneous/cli/login.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Generate an authentication for use in non-interactive environments.

```bash
```
Usage: juno login [options]

Options:
Expand Down
2 changes: 1 addition & 1 deletion docs/miscellaneous/cli/logout.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Log out of the current device. ⚠️ This action does not remove controllers from the module.

```bash
```
Usage: juno logout [options]

Options:
Expand Down
2 changes: 1 addition & 1 deletion docs/miscellaneous/cli/open.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Open your satellite in your browser.

```bash
```
Usage: juno open [options]

Options:
Expand Down
4 changes: 2 additions & 2 deletions docs/miscellaneous/cli/upgrade.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
Upgrade a module to a new version.

```bash
```
Usage: juno upgrade [options]

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

Expand Down
2 changes: 1 addition & 1 deletion docs/miscellaneous/cli/use.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Switch between multiple profiles.

```bash
```
Usage: juno use [options]

Options:
Expand Down
9 changes: 5 additions & 4 deletions docs/miscellaneous/cli/version.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
Check the version of the modules and cli.
Check the version of the modules and CLI.

```bash
Usage: juno version [options]
```
Usage: juno init [options]

Options:
-h, --help Output usage information.
-c, --cli Check only the version of the CLI.
-m, --mode Set env mode. For example production or a custom string. Default is production.
-h, --help Output usage information.
```
2 changes: 1 addition & 1 deletion docs/miscellaneous/cli/whoami.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Display your current profile, controller, and links to your satellite.

```bash
```
Usage: juno whoami [options]

Options:
Expand Down
2 changes: 1 addition & 1 deletion showcase.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
"url": "https://m5rwi-daaaa-aaaal-acrpq-cai.icp0.io",
"description": "An adventure around the world to meet great souls and promote good stuff.",
"img": "/showcase/aegir.jpg",
"github":"https://github.com/Kyliux/Icloud"
"github": "https://github.com/Kyliux/Icloud"
},
{
"title": "ICPFA",
Expand Down
25 changes: 17 additions & 8 deletions src/components/Spotlight/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,23 @@ export default function Spotlight({
</div>

<div className={styles.content}>
<h4>
{title}
{github && (
<Link href={github} target="_blank" rel="noreferrer noopener nofollow" className={styles.githubLink}>
<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} />
</Link>
)}
</h4>
<h4>
{title}
{github && (
<Link
href={github}
target="_blank"
rel="noreferrer noopener nofollow"
className={styles.githubLink}
>
<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}
/>
</Link>
)}
</h4>
<p>{description}</p>
</div>
</article>
Expand Down