Installing the Openlayer CLI
To download and install Openlayer CLI, run the command that corresponds to your OS:Getting started
Once the CLI is installed,openlayer init is the fastest
way to connect a project. It signs you in, creates or links the Openlayer project, and sets up
development mode, monitoring, or both:
1
Install the CLI
Run the install command for your operating
system.
2
Run openlayer init
openlayer init signs you in and
creates or links the project, so you do not need separate
login and
link steps.3
Push to Openlayer
openlayer push creates a commit on
your project and runs your tests. init offers to do this first push for
you.Checking the version
The--version option can be used to verify the version of Openlayer CLI being used.
Using in a CI/CD environment
Openlayer CLI requires you to log in and authenticate before performing tasks, such as pushing or accessing test results. In a terminal environment, you can useopenlayer login, which requires manual input.
In a CI/CD environment where manual input is not possible, you can use your Openlayer API key
and the --api-key option to authenticate. Refer to the CI/CD guide for details.
openlayer init is interactive by default, but it also has a
non-interactive mode for CI and coding
agents.