The Syro Command Line Interface (CLI) is a tool that enables secure access to your project secrets. It integrates directly into your workflows, supporting both local development and CI/CD pipelines.
Prerequisites:
node -v
and npm -v
. If the commands return version numbers, Node and npm have been installed successfully and are ready for use in any directory.To install the Syro CLI package globally, execute npm i -g ****@withsyro/cli
. If the package is installed successfully without any errors, the syro
command will be available globally in your system. To verify this, type syro
in your terminal.
syro pull
: Pulls secrets from your Syro projectThe Syro CLI allows you to inject secrets into your process by using the syro pull
command. All secrets associated with the provided access token are automatically exported to a .env file in your current directory. The syro pull
command requires the following arguments:
syro pull **<Access-Token>**
Access Token <Access-Token>
: A project specific access token that is uses to pull in project specific secrets. To retrieve the access token, visit the "Settings" page of the relevant project. The “Access Tokens” section contains your project specific tokens.
Note: You will need to generate a new token if this is the first time you are accessing the CLI app.
For more information, take a look at API & Access Token documentation
The Syro CLI lets you inject secrets from multiple projects as well. You can provide multiple access tokens to the syro pull
command All secrets associated with the provided access tokens are automatically exported to a .env file in your current directory. Note that the subsequent access token overwrites the preceding tokens secrets.