semantic-release/docs/usage/getting-started.md

Getting started

In order to use semantic-release you must follow these steps:

• Install semantic-release in your project
• Configure your Continuous Integration service to run semantic-release
• Configure your Git repository and package manager repository authentication in your Continuous Integration service
• Configure semantic-release options and plugins

Alternatively those steps can be easily done with the semantic-release interactive CLI:

npm install -g semantic-release-cli

cd your-module
semantic-release-cli setup

See the semantic-release-cli documentation for more details.

Note: only a limited number of options, CI services and plugins are currently supported by semantic-release-cli.