Skip to main content

Installation

Get up and running with Signaloid CLI in minutes.

Prerequisites​

Before installing Signaloid CLI, ensure you have:

  • Node.js v22.x or higher (Download)
  • npm v6.11.0 or higher (comes with Node.js)
  • git installed on your system
  • A GitHub Personal Access Token with read:packages and repo scopes

Getting a GitHub Access Token​

Signaloid CLI is distributed via GitHub Packages. You'll need a personal access token:

  1. Go to GitHub Settings → Developer settings → Personal access tokens
  2. Click "Generate new token (classic)"
  3. Give it a descriptive name (e.g., "Signaloid CLI")
  4. Select the following scopes:
    • ✅ read:packages - Download packages from GitHub Package Registry
    • ✅ repo - Access private repositories (if needed)
  5. Click "Generate token"
  6. Copy the token immediately - you won't be able to see it again!

Installation Steps​

1. Authenticate with GitHub Packages​

Configure npm to use GitHub Packages registry:

echo "Enter your GitHub Access Token:" && \
read -s GITHUB_TOKEN && \
npm config set @signaloid:registry https://npm.pkg.github.com/ && \
npm config set //npm.pkg.github.com/:_authToken $GITHUB_TOKEN
Alternative Method

You can also set the token manually:

npm config set @signaloid:registry https://npm.pkg.github.com/
npm config set //npm.pkg.github.com/:_authToken YOUR_TOKEN_HERE

2. Install Signaloid CLI Globally​

npm install -g @signaloid/signaloid-cli

3. Verify Installation​

Check that the Signaloid CLI is installed correctly:

signaloid-cli --version

Getting Your Signaloid API Key​

To use Signaloid CLI, you need an API key from the Signaloid Cloud Developer Platform:

  1. Go to signaloid.io and log in
  2. Navigate to Settings → Cloud Engine API
  3. Click "Generate Key"
  4. Copy the key and save it securely
  5. Important: You won't be able to view this key again after leaving the page

First-Time Setup​

Authenticate with your API key:

signaloid-cli auth login --api-key YOUR_API_KEY

You should see:

✔ API key authenticated
Hello!
Note

Your API key is stored securely in your config file with restricted permissions (read/write for owner only on Unix systems).

Updating Signaloid CLI​

To update to the latest version:

npm update -g @signaloid/signaloid-cli

Check the new version:

signaloid-cli --version

Uninstalling​

To remove Signaloid CLI:

npm uninstall -g @signaloid/signaloid-cli

Troubleshooting​

"Cannot find module" Error​

If you get a module not found error, try clearing npm cache:

npm cache clean --force
npm install -g @signaloid/signaloid-cli

GitHub Authentication Failed​

If GitHub authentication fails:

  1. Verify your token has the correct scopes
  2. Check that the token hasn't expired
  3. Try regenerating a new token

Next Steps​

Now that you have Signaloid CLI installed:

Need Help?

If you run into any issues, open an issue on GitHub.

Last updated on