Skip to main content

Installation

Get up and running with Signaloid CLI in minutes.

Prerequisites​

Before installing Signaloid CLI, ensure you have:

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

We recommend installing Node.js via nvm or fnm rather than a system installer. Version managers install Node in your home directory, so npm install -g works without sudo and avoids permission errors.

Windows

Use fnm on Windows, because nvm runs on macOS and Linux only. The commands on this page work unchanged in Git Bash. If you run them in PowerShell instead, run npm.cmd and signaloid-cli.cmd, because the default PowerShell execution policy blocks npm and signaloid-cli, and quote the registry name, as in npm.cmd config set "@signaloid:registry" https://npm.pkg.github.com/.

Getting a GitHub access token​

Signaloid CLI is distributed via GitHub Packages. You will 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 will not 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 with read:packages and repo scopes:" \
  && read -s GITHUB_TOKEN \
  && npm config set @signaloid:registry https://npm.pkg.github.com/ \
  && npm config set //npm.pkg.github.com/:_authToken $GITHUB_TOKEN

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 will not 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 has not 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