Skip to content

Commit b742b28

Browse files
docs: Update CLI documentation (#476)
Co-authored-by: juno-bot <juno-bot@users.noreply.github.com>
1 parent b57431d commit b742b28

14 files changed

Lines changed: 14 additions & 12 deletions

File tree

docs/reference/cli/clear.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Usage: juno clear [options]
55
66
Options:
77
-f, --fullPath Clear a particular file of your app.
8-
-m, --mode Set env mode. For example production or a custom string. Default is production.
8+
-m, --mode Choose which environment to use (production, staging, development). Defaults to production if omitted.
99
--container-url Override a custom container URL. If not provided, defaults to production or the local container in development mode.
1010
--console-url Specify a custom URL to access the developer Console.
1111
-h, --help Output usage information.

docs/reference/cli/config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Apply configuration to satellite.
44
Usage: juno config [options]
55
66
Options:
7-
-m, --mode Set env mode. For example production or a custom string. Default is production.
7+
-m, --mode Choose which environment to use (production, staging, development). Defaults to production if omitted.
88
--container-url Override a custom container URL. If not provided, defaults to production or the local container in development mode.
99
--console-url Specify a custom URL to access the developer Console.
1010
-h, --help Output usage information.

docs/reference/cli/deploy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Options:
88
--no-apply Submit the deployment as a change but do not apply it yet.
99
-k, --keep-staged Keep staged assets in memory after applying the change.
1010
-i, --immediate Deploy files instantly (bypasses the change workflow).
11-
-m, --mode Set env mode. For example production or a custom string. Default is production.
11+
-m, --mode Choose which environment to use (production, staging, development). Defaults to production if omitted.
1212
--container-url Override a custom container URL. If not provided, defaults to production or the local container in development mode.
1313
--console-url Specify a custom URL to access the developer Console.
1414
-h, --help Output usage information.

docs/reference/cli/functions-publish.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Options:
77
--no-apply Submit the release as a change but do not apply it yet.
88
-k, --keep-staged Keep staged assets in memory after applying the change.
99
-s, --src A path to a specific local gzipped WASM file to publish.
10-
-m, --mode Set env mode. For example production or a custom string. Default is production.
10+
-m, --mode Choose which environment to use (production, staging, development). Defaults to production if omitted.
1111
--container-url Override a custom container URL. If not provided, defaults to production or the local container in development mode.
1212
--console-url Specify a custom URL to access the developer Console.
1313
-h, --help Output usage information.

docs/reference/cli/functions.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ Usage: juno functions <subcommand> [options]
66
Subcommands:
77
build Build your functions.
88
eject Scaffold the necessary files for developing your serverless functions.
9+
init Alias for eject.
910
publish Publish a new version of your functions.
1011
upgrade Upgrade your satellite's serverless functions.
1112

docs/reference/cli/init.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Usage: juno init [options]
55
66
Options:
77
--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.
8+
-m, --mode Choose which environment to use (production, staging, development). Defaults to production if omitted.
99
--container-url Override a custom container URL. If not provided, defaults to production or the local container in development mode.
1010
--console-url Specify a custom URL to access the developer Console.
1111
-h, --help Output usage information.

docs/reference/cli/login.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,6 @@ Usage: juno login [options]
55
66
Options:
77
-b, --browser A particular browser to open. supported: chrome|firefox|edge.
8+
-m, --mode Choose which environment to use (production, staging, development). Defaults to production if omitted.
89
-h, --help Output usage information.
910
```

docs/reference/cli/open.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Usage: juno open [options]
66
Options:
77
-b, --browser A particular browser to open. supported: chrome|firefox|edge.
88
-c, --console Open satellite in the console.
9-
-m, --mode Set env mode. For example production or a custom string. Default is production.
9+
-m, --mode Choose which environment to use (production, staging, development). Defaults to production if omitted.
1010
--container-url Override a custom container URL. If not provided, defaults to production or the local container in development mode.
1111
--console-url Specify a custom URL to access the developer Console.
1212
-h, --help Output usage information.

docs/reference/cli/snapshot.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Subcommands:
1010
1111
Options:
1212
-t, --target Which module type should be snapshotted? Valid targets are satellite, mission-control or orbiter.
13-
-m, --mode Set env mode. For example production or a custom string. Default is production.
13+
-m, --mode Choose which environment to use (production, staging, development). Defaults to production if omitted.
1414
--container-url Override a custom container URL. If not provided, defaults to production or the local container in development mode.
1515
--console-url Specify a custom URL to access the developer Console.
1616
-h, --help Output usage information.

docs/reference/cli/start.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Usage: juno start [options]
55
66
Options:
77
-t, --target Which module type should be started? Valid targets are satellite, mission-control or orbiter.
8-
-m, --mode Set env mode. For example production or a custom string. Default is production.
8+
-m, --mode Choose which environment to use (production, staging, development). Defaults to production if omitted.
99
--container-url Override a custom container URL. If not provided, defaults to production or the local container in development mode.
1010
--console-url Specify a custom URL to access the developer Console.
1111
-h, --help Output usage information.

0 commit comments

Comments
 (0)