Skip to main content

Installation

Multiple ways to install Keyway CLI depending on your preferences.

Quick Start (No Install)​

Run directly with npx - no installation required:

npx @keywaysh/cli init

This is the fastest way to get started. Works anywhere Node.js is installed.

Package Managers​

npm​

npm install -g @keywaysh/cli

pnpm​

pnpm add -g @keywaysh/cli

yarn​

yarn global add @keywaysh/cli

bun​

bun add -g @keywaysh/cli

After installing globally, use keyway directly:

keyway init
keyway pull
keyway sync vercel

Homebrew (macOS & Linux)​

brew install keywaysh/tap/keyway

This installs a native binary - faster startup, no Node.js required.

Shell Script (Linux & macOS)​

curl -fsSL https://keyway.sh/install.sh | sh

Downloads the latest binary to /usr/local/bin/keyway.

Manual Download (All Platforms)​

Download pre-built binaries from GitHub Releases:

PlatformArchitectureDownload
macOSApple Silicon (M1/M2/M3)keyway-darwin-arm64
macOSIntelkeyway-darwin-x64
Linuxx64keyway-linux-x64
LinuxARM64keyway-linux-arm64
Windowsx64keyway-win-x64.exe

Windows Installation​

  1. Download keyway-win-x64.exe from releases
  2. Rename to keyway.exe
  3. Move to a folder in your PATH (e.g., C:\Windows\System32 or create C:\keyway)
  4. Run keyway init in your project

Linux/macOS Manual Installation​

# Download (replace URL with your platform)
curl -L -o keyway https://github.com/keywaysh/cli/releases/latest/download/keyway-linux-x64

# Make executable
chmod +x keyway

# Move to PATH
sudo mv keyway /usr/local/bin/

Verify Installation​

keyway --version

CI/CD​

For CI/CD environments, see CI/CD Integration for GitHub Actions, GitLab CI, and more.

npx in CI

Using npx @keywaysh/cli in CI works but adds ~2s for package resolution. For faster builds, pre-install or use the binary.

Updating​

npm/pnpm/yarn/bun​

npm update -g @keywaysh/cli

Homebrew​

brew upgrade keyway

Manual​

Re-download the latest binary from releases.

Uninstalling​

npm​

npm uninstall -g @keywaysh/cli

Homebrew​

brew uninstall keyway

Manual​

rm /usr/local/bin/keyway
rm -rf ~/.config/keyway-nodejs ~/.keyway  # Remove config (optional)

Next Steps​