Bytesafe CLI

The Bytesafe CLI offers the option to control your registries from the command line.

Bytesafe CLI complements your regular tools (npm / yarn / pnpm) with actions to manage Bytesafe registries and the packages stored within.

For instance you may use the Bytesafe CLI to create new registries, push packages from a registry to upstreams, pull packages from upstreams into a registry and more. Most Bytesafe actions can be performed either from the CLI or in the web application.

Download Bytesafe CLI

The bytesafe CLI is available for macOS, Linux and Windows:

When should I use the Bytesafe CLI instead of other tooling?

The main difference between Bytesafe CLI and npm / yarn / pnpm in terms of package actions, consist of the scenarios where you would use them.

Bytesafe CLI is for managing packages in Bytesafe registries. Like pulling packages into a specific registry from an upstream.

While npm install, as an example, is for fetching and installing packages (and dependencies) into your local project workspace.

Configure Bytesafe CLI by setting the endpoint

To be able to login to Bytesafe using the CLI for the first time, first use the bytesafe configure command.

$ bytesafe configure

You will then be prompted to enter your endpoint which is your Bytesafe workspace, for example https://example.bytesafe.dev

Enter endpoint: https://example.bytesafe.dev

Successfully configured the endpoint. Continue with login: 'bytesafe login'

Endpoint set by the configure command on first use will be stored in the .bytesaferc file as the default endpoint.

To connect Bytesafe CLI to another endpoint, use the --endpoint flag.

Login with Bytesafe CLI

For login to Bytesafe, use the bytesafe login command.

$ bytesafe login

Login to endpoint: 'https://example.bytesafe.dev'

Visit 'https://example.bytesafe.dev/console/cli' to retrieve a new token

Enter token: BA8G...

Login successful. Logged in as: ...

This action requires a token, which is fetched from the Access tokens page in Bytesafe. The CLI will provide an workspace specific link to the CLI token.

cli-access-token

You are now logged in with the Bytesafe CLI. The CLI login token is valid for 30 days.

Bytesafe CLI commands

With the Bytesafe CLI you are able to execute the most important commands related to registries and packages for your Bytesafe workspace.

Available bytesafe commands can always be displayed by using the help function.

$ bytesafe help

Usage: bytesafe [options...] command [options...] [args...]


Package CLI commands

Work with packages in your registries using Bytesafe CLI

Registry CLI commands

Manage registries in your workspace using Bytesafe CLI