Installation

Install the Workrail CLI globally using your preferred package manager.

Requirements

• Node.js 18+
• Git repository for syncing

Install via npm

npm install -g @workrail/cli

Install via pnpm

pnpm add -g @workrail/cli

Install via bun

bun add -g @workrail/cli

Verify installation

After installation, verify the CLI is available:

workrail --version

You should see the version number (e.g., workrail 0.2.4).

Next steps

Once installed, you're ready to:

1. Authenticate with your account
2. Link your first repository
3. Run your first sync

Troubleshooting

Command not found after install:

Make sure your Node.js global bin directory is in your PATH:

# Check npm global bin location
npm bin -g

# Add to PATH (add to ~/.zshrc or ~/.bashrc)
export PATH="$(npm bin -g):$PATH"

Permission denied:

On some systems, you may need to use sudo (not recommended) or fix npm permissions. See npm's permission guide.

Updating

To update to the latest version:

npm update -g @workrail/cli
# or
pnpm update -g @workrail/cli
# or
bun update -g @workrail/cli

Uninstalling

npm uninstall -g @workrail/cli
# or
pnpm remove -g @workrail/cli
# or
bun remove -g @workrail/cli