Skip to content

Commit 5a4aa03

Browse files
docs: deprecate CLI juno use (#486)
* docs: deprecate CLI juno use Signed-off-by: David Dal Busco <david.dalbusco@outlook.com> * πŸ“„ Update LLMs.txt snapshot for PR review * docs: remove modes now documented in 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 19b9bfc commit 5a4aa03

4 files changed

Lines changed: 101 additions & 93 deletions

File tree

β€Ž.llms-snapshots/llms-full.txtβ€Ž

Lines changed: 49 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -7371,24 +7371,6 @@ If you've previously authenticated your terminal and decide to log in again, the
73717371

73727372
This allows you to reuse your authorization, especially when creating new modules like satellites or orbiters.
73737373

7374-
#### Modes
7375-
7376-
The CLI supports multiple environment modes (`production`, `staging`, `development`, etc.).
7377-
7378-
Each mode requires its own login and identity for security reasons. For example: `juno login --mode staging` or `juno login --mode development`. If no mode is specified, it defaults to `production`.
7379-
7380-
#### How does it work?
7381-
7382-
A new [principal](/docs/terminology.md#principal) is generated on your local machine and added as a administrator [access key](/docs/miscellaneous/access-keys.md) of the selected modules. This principal is then used to authenticate any CLI calls made from your terminal to your satellites, mission controls or other modules.
7383-
7384-
The key is saved in the OS-specific user's variables path, for example:
7385-
7386-
| OS | Path |
7387-
| --- | --- |
7388-
| Mac | `~/Library/Preferences/juno-nodejs` |
7389-
| Windows | `%APPDATA%\juno-nodejs\Config` (for example, `C:\Users\USERNAME\AppData\Roaming\juno-nodejs\Config`) |
7390-
| Linux | `~/.config/juno-nodejs` (or `$XDG_CONFIG_HOME/juno-nodejs`) |
7391-
73927374
---
73937375

73947376
### Logout
@@ -7634,34 +7616,74 @@ Usage: juno open [options]Options: -b, --browser A particular browser t
76347616

76357617
---
76367618

7637-
### Use
7619+
### Version
76387620

7639-
Switch between multiple profiles.
7621+
Check the version of the modules and CLI.
76407622

76417623
```
7642-
Usage: juno use [options]Options: -p, --profile The profile that should be use. -l, --list What are the available profiles. -h, --help Output usage information.
7624+
Usage: juno init [options]Options: -c, --cli Check only the version of the CLI. -m, --mode Choose which environment to use (production, staging, development). Defaults to production if omitted. --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.
76437625
```
76447626

76457627
---
76467628

7647-
### Version
7629+
### Who am I?
76487630

7649-
Check the version of the modules and CLI.
7631+
Display your current profile, access key, and links to your satellite.
76507632

76517633
```
7652-
Usage: juno init [options]Options: -c, --cli Check only the version of the CLI. -m, --mode Choose which environment to use (production, staging, development). Defaults to production if omitted. --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.
7634+
Usage: juno whoami [options]Options: -h, --help Output usage information. -m, --mode Choose which environment to use (production, staging, development). Defaults to production if omitted. --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.
76537635
```
76547636

76557637
---
76567638

7657-
### Who am I?
7639+
## Environment
76587640

7659-
Display your current profile, access key, and links to your satellite.
7641+
Some CLI flags affect the context of your commands, such as which environment you're working in or which identity you're using. These flags are global and apply to most commands.
7642+
7643+
---
7644+
7645+
### Mode
7646+
7647+
The `--mode` flag lets you target a specific environment when executing CLI commands. This is useful for working across development, staging, and production setups.
76607648

76617649
```
7662-
Usage: juno whoami [options]Options: -h, --help Output usage information. -m, --mode Choose which environment to use (production, staging, development). Defaults to production if omitted. --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.
7650+
juno login --mode developmentjuno deploy --mode staging
7651+
```
7652+
7653+
The value for `--mode` can be any string. If omitted, it defaults to production.
7654+
7655+
---
7656+
7657+
### Profile
7658+
7659+
The optional `--profile` flag lets you switch between different identities. Useful when working with multiple Mission Controls.
7660+
7661+
```
7662+
juno login --profile teamjuno deploy --profile team --mode staging
76637663
```
76647664

7665+
It accepts any string. If omitted, no profile is used.
7666+
7667+
---
7668+
7669+
### Local Persistence
7670+
7671+
Unless you run it in headless mode with a token, the Juno CLI stores data locally in the following OS-specific user's variables path to work properly.
7672+
7673+
| OS | Path |
7674+
| --- | --- |
7675+
| Mac | `~/Library/Preferences/juno-nodejs` |
7676+
| Windows | `%APPDATA%\juno-nodejs\Config` (for example, `C:\Users\USERNAME\AppData\Roaming\juno-nodejs\Config`) |
7677+
| Linux | `~/.config/juno-nodejs` (or `$XDG_CONFIG_HOME/juno-nodejs`) |
7678+
7679+
These config files are created based on the selected `--profile` and `--mode`:
7680+
7681+
| File | Encrypted | Purpose |
7682+
| --- | --- | --- |
7683+
| `juno[-profile][-mode]` | βœ… | Stores the [access key](/docs/miscellaneous/access-keys.md) ([principal](/docs/terminology.md#principal)) and list of modules. |
7684+
| `juno[-profile][-mode]-cli-settings` | | Stores CLI preferences, e.g. whether the access key file is encrypted (to avoid unnecessary prompts). |
7685+
| `juno[-profile][-mode]-cli-state` | | Stores ephemeral state like applied config hashes. |
7686+
76657687
# Configuration
76667688

76677689
When the `juno` command is run from your terminal or used in a CI environment, it will automatically attempt to locate a config file named `juno.config.ts` or `juno.config.js` or `juno.config.json` within your project's root directory.
@@ -8110,20 +8132,6 @@ import { defineConfig } from "@junobuild/config";export default defineConfig(({
81108132

81118133
---
81128134

8113-
## Modes
8114-
8115-
By default, the CLI runs command for the `production` mode.
8116-
8117-
This means when running a `juno` command in your terminal, it will pass the mode `production` to read your configuration.
8118-
8119-
You can overwrite the default mode used for a command by passing the `--mode` option flag. For example, if you want to deploy your app for a `staging` mode:
8120-
8121-
```
8122-
juno deploy --mode staging
8123-
```
8124-
8125-
---
8126-
81278135
## Multiple Environments
81288136

81298137
You might want to deploy or manage a project across different environments, such as staging and production. Juno supports this through the `ids` field, allowing you to define separate Satellite IDs for each ([mode](#modes)).

β€Ždocs/reference/cli.mdxβ€Ž

Lines changed: 52 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -61,26 +61,6 @@ If you've previously authenticated your terminal and decide to log in again, the
6161

6262
This allows you to reuse your authorization, especially when creating new modules like satellites or orbiters.
6363

64-
#### Modes
65-
66-
The CLI supports multiple environment modes (`production`, `staging`, `development`, etc.).
67-
68-
Each mode requires its own login and identity for security reasons.
69-
For example: `juno login --mode staging` or `juno login --mode development`.
70-
If no mode is specified, it defaults to `production`.
71-
72-
#### How does it work?
73-
74-
A new [principal] is generated on your local machine and added as a administrator [access key](../miscellaneous/access-keys.md) of the selected modules. This principal is then used to authenticate any CLI calls made from your terminal to your satellites, mission controls or other modules.
75-
76-
The key is saved in the OS-specific user's variables path, for example:
77-
78-
| OS | Path |
79-
| ------- | ---------------------------------------------------------------------------------------------------- |
80-
| Mac | `~/Library/Preferences/juno-nodejs` |
81-
| Windows | `%APPDATA%\juno-nodejs\Config` (for example, `C:\Users\USERNAME\AppData\Roaming\juno-nodejs\Config`) |
82-
| Linux | `~/.config/juno-nodejs` (or `$XDG_CONFIG_HOME/juno-nodejs`) |
83-
8464
---
8565

8666
### Logout
@@ -292,14 +272,6 @@ import Open from "./cli/open.md";
292272

293273
---
294274

295-
### Use
296-
297-
import Use from "./cli/use.md";
298-
299-
<Use />
300-
301-
---
302-
303275
### Version
304276

305277
import Version from "./cli/version.md";
@@ -314,6 +286,58 @@ import WhoAmI from "./cli/whoami.md";
314286

315287
<WhoAmI />
316288

289+
---
290+
291+
## Environment
292+
293+
Some CLI flags affect the context of your commands, such as which environment you're working in or which identity you're using. These flags are global and apply to most commands.
294+
295+
---
296+
297+
### Mode
298+
299+
The `--mode` flag lets you target a specific environment when executing CLI commands. This is useful for working across development, staging, and production setups.
300+
301+
```bash
302+
juno login --mode development
303+
juno deploy --mode staging
304+
```
305+
306+
The value for `--mode` can be any string. If omitted, it defaults to production.
307+
308+
---
309+
310+
### Profile
311+
312+
The optional `--profile` flag lets you switch between different identities. Useful when working with multiple Mission Controls.
313+
314+
```bash
315+
juno login --profile team
316+
juno deploy --profile team --mode staging
317+
```
318+
319+
It accepts any string. If omitted, no profile is used.
320+
321+
---
322+
323+
### Local Persistence
324+
325+
Unless you run it in headless mode with a token, the Juno CLI stores data locally in the following OS-specific user's variables path to work properly.
326+
327+
| OS | Path |
328+
| ------- | ---------------------------------------------------------------------------------------------------- |
329+
| Mac | `~/Library/Preferences/juno-nodejs` |
330+
| Windows | `%APPDATA%\juno-nodejs\Config` (for example, `C:\Users\USERNAME\AppData\Roaming\juno-nodejs\Config`) |
331+
| Linux | `~/.config/juno-nodejs` (or `$XDG_CONFIG_HOME/juno-nodejs`) |
332+
333+
These config files are created based on the selected `--profile` and `--mode`:
334+
335+
| File | Encrypted | Purpose |
336+
| ------------------------------------ | --------- | ----------------------------------------------------------------------------------------------------- |
337+
| `juno[-profile][-mode]` | βœ… | Stores the [access key](../miscellaneous/access-keys.md) ([principal]) and list of modules. |
338+
| `juno[-profile][-mode]-cli-settings` | | Stores CLI preferences, e.g. whether the access key file is encrypted (to avoid unnecessary prompts). |
339+
| `juno[-profile][-mode]-cli-state` | | Stores ephemeral state like applied config hashes. |
340+
317341
[satellite]: ../terminology.md#satellite
318342
[mission control]: ../terminology.md#mission-control
319343
[principal]: ../terminology.md#principal

β€Ždocs/reference/cli/use.mdβ€Ž

Lines changed: 0 additions & 10 deletions
This file was deleted.

β€Ždocs/reference/configuration.mdxβ€Ž

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -481,20 +481,6 @@ export default defineConfig(({ mode }) => ({
481481

482482
---
483483

484-
## Modes
485-
486-
By default, the CLI runs command for the `production` mode.
487-
488-
This means when running a `juno` command in your terminal, it will pass the mode `production` to read your configuration.
489-
490-
You can overwrite the default mode used for a command by passing the `--mode` option flag. For example, if you want to deploy your app for a `staging` mode:
491-
492-
```bash
493-
juno deploy --mode staging
494-
```
495-
496-
---
497-
498484
## Multiple Environments
499485

500486
You might want to deploy or manage a project across different environments, such as staging and production. Juno supports this through the `ids` field, allowing you to define separate Satellite IDs for each [mode](#modes).

0 commit comments

Comments
Β (0)