Installation
Get Versu set up in your project with one of the following methods.
NPM Installation
The easiest way to install Versu is via npm:
bash
npm install -D @versu/cliOr if you want to use it globally:
bash
npm install -g @versu/cliYarn Installation
If you're using Yarn, install with:
bash
yarn add --dev @versu/cliOr globally:
bash
yarn global add @versu/cliPNPM Installation
For PNPM users:
bash
pnpm add -D @versu/cliOr globally:
bash
pnpm add -g @versu/cliVia GitHub Action
If you want to use Versu in your CI/CD pipeline, add this to your GitHub Actions workflow:
yaml
- uses: versuhq/versu@v3
with:
# Your configuration hereSee the GitHub Action documentation for more details.
Verify Installation
After installation, verify Versu is working:
bash
# If installed locally
npx @versu/cli --version
# If installed globally
versu --versionYou should see the version number displayed.
System Requirements
- Node.js: 24 or higher
- Git: 2.0.0 or higher (for commit analysis)
Next Steps
Now that Versu is installed, check out:
- Quick Start - Run your first versioning cycle
- Configuration - Set up Versu for your project
Troubleshooting
Installation Fails
If you encounter issues during installation:
- Clear your npm cache:
npm cache clean --force - Delete
node_modulesand lock files - Reinstall:
npm install
Version Command Not Found
If versu --version doesn't work:
- Ensure Node.js is installed:
node --version - Try using
npx:npx @versu/cli --version - For global install, check your npm path:
npm config get prefix
Getting Help
If you need help:
- Check the FAQ
- Open an issue on GitHub
- Read the API documentation
