Skip to main content

CLI Reference

CLI for the Greyhound deployment control plane

Prerequisites

  • Node.js >= 24.12.0 (includes npm)
  • gh CLI authenticated with access to the Underdog-Inc GitHub org

Installing Node.js via nvm

If you don't have Node.js installed, the recommended approach is nvm:

# Install nvm
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.3/install.sh | bash

# Restart your terminal, then install Node.js
nvm install 24
nvm use 24

# Set as default so new terminals use it automatically
nvm alias default 24

# Verify
node --version # should print v24.x.x
npm --version

Installation

gh api repos/Underdog-Inc/greyhound/contents/packages/cli/install.sh -H "Accept: application/vnd.github.raw+json" | bash

Or pin a specific version:

VERSION=0.1.0 gh api repos/Underdog-Inc/greyhound/contents/packages/cli/install.sh -H "Accept: application/vnd.github.raw+json" | bash

Manual installation

If you prefer to install manually, configure your .npmrc for GitHub Packages:

@underdog-inc:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=YOUR_GITHUB_TOKEN

Then install globally:

npm install -g @underdog-inc/greyhound-cli

Global Options

These options apply to all commands.

FlagDescriptionDefault
-V, --versionoutput the version number-
--api-url <url>Greyhound API URL (default: GREYHOUND_API_URL env var, or https://greyhound-api.prod.underdog.tools)-

Environment Variables

VariableDescription
GREYHOUND_API_URLAPI URL (overridden by --api-url flag)