Install the CLI
Install the orvio command with npm, or run it without installing.
The CLI is a command called orvio. It signs you in, searches the catalog and adds a product's current release to your project. It needs Node 20 or later and has no other dependencies.
Install#
$ npm install -g orvio $ orvio --version
npx runs the command without installing it. Use npx orvio in front of any command on these pages.
Check#
orvio --version prints the version. orvio --help lists the commands. orvio <command> --help explains one.
Settings#
| Environment variable | Meaning |
|---|---|
ORVIO_URL | The Orvio website to use. Default: https://orvio.design. |
ORVIO_NO_BROWSER | Set to 1 to print the sign-in link without opening a browser. |
Where the CLI keeps its sign-in#
In one file, config.json, in your system's config folder:
| System | Folder |
|---|---|
| Linux | $XDG_CONFIG_HOME/orvio/, by default ~/.config/orvio/ |
| macOS | ~/Library/Application Support/orvio/ |
| Windows | %APPDATA%\orvio\ |
The file is private to you (mode 600 where your system supports it). The CLI never prints or logs tokens.
Update#
$ npm install -g orvio@latest
If the CLI is too old for the service, it says so and prints this command: cli_outdated, exit code 1.
Next#
The CLI is published on npm as orvio, under the MIT licence. That covers the CLI's code only. The products you pull are covered by the Orvio Member Licence.