CLI
The Juno CLI (GitHub: https://github.com/junobuild) provides a variety of tools for managing and deploying satellite.
Installation
- Install Node.js (version LTS or above) from https://nodejs.org/en/download/. You can use nvm (https://github.com/nvm-sh/nvm) to manage multiple Node.js versions on a single machine.
- When installing Node.js, it is recommended to check all related dependency checkboxes.
- Install the Juno CLI globally or in your sandbox using npm:
npm i -g @junobuild/cli
Login
The CLI requires authentication to make changes, such as deploying an application, upgrading a satellite or mission control, etc.
The authentication process requires a browser:
- Start the login process with the following command:
juno login
-
Sign in to the console if not already logged in.
-
Select the satellites and/or mission control you would like to control from your local device.
-
Confirm
The terminal on your local machine should now be authorized to control the selected objects.
If you've previously authenticated your terminal and decide to log in again, the CLI will prompt you about reusing your existing identity. This allows you to reuse your authorization, especially when creating new segments like satellites or orbiters.
How does it work?
A new principal is generated on your local machine and added as a controller of the selected segments. This principal is then used to authenticate any CLI calls made from your terminal to your satellites and mission controls.
The key is saved in the OS-specific user's variables path.
| OS | Path |
|---|---|
| Mac | ~/Library/Preferences/juno-nodejs |
| Windows | %APPDATA%\juno-nodejs\Config (for example, C:\Users\USERNAME\AppData\Roaming\juno-nodejs\Config) |
| Linux | ~/.config/juno-nodejs (or $XDG_CONFIG_HOME/juno-nodejs) |
Logout
To remove the authorization of your local machine:
juno logout
This currently does not remove the controllers from satellites and/or mission control and/or orbiter. It only logs out your local machine and removes the locally saved key (principal).
Init
The juno init command creates a juno.config file in the root directory of your project.
You will be prompted to select your preferred format: TypeScript, JavaScript, or JSON.
We recommend using the first two options because they can leverage your IDE's IntelliSense with type hints.
This file is necessary for deploying, configuring, or running any other CLI commands for your app.
Read more about the configuration.
Deploy
To deploy an app to a satellite using Juno, run the following command from the project directory:
juno deploy
This command uploads each file separately and computes and uploads the corresponding hashes. Subsequent deploys will only upload files that have changed.
Config
To apply any changes to your storage configuration, run the following command from your project directory:
juno config
Clear
To clear the on-chain assets of the app, run the following command:
juno clear
This command removes existing files from the satellite and only affects the app assets. The user's uploaded files will not be cleared as the app is deployed to a reserved collection, #dapp.
If you have compressed (gzip and brotli) your bundle and assets after deploying your app, it is also necessary to clear the assets. This is because a certification tree of all assets needs to be calculated.
Upgrade
If the smart contracts' code of your mission control, satellites or orbiters become outdated, you can upgrade them.
Running the following command from the project directory upgrade your satellite (default option):
juno upgrade --target s|m|o
- We recommend that you stay current with the Juno releases, as some features may not perform correctly in the console if your smart contracts are outdated.
- Upgrading requires a stable internet connection for a successful process.