Workrail CLI

Track your engineering work, capture achievements, and build a career record from your terminal.

Installation

Install globally using your preferred package manager:

npm:

npm install -g @workrail/cli

pnpm:

pnpm add -g @workrail/cli

bun:

bun add -g @workrail/cli

Requirements: Node.js 18+ (automatically installed with the CLI)

Supported Platforms

• macOS (Apple Silicon & Intel)
• Linux (x64 & ARM64)
• Windows (x64)

The CLI automatically downloads the correct binary for your platform during installation.

Quick Start

1. Authenticate (opens browser):

   workrail auth login

2. Link your repository to a Workrail project:

   workrail link

3. Sync your work (captures commit metadata, not source code):

   workrail sync

4. Create an entry manually (for non-code achievements):

   workrail entry add

5. Enable autosync (optional - runs sync on a schedule):

   workrail autosync enable

6. View your dashboard at workrail.dev

Common Commands

| Command | Description | | --------------------------- | --------------------------------------- | | workrail auth login | Authenticate via browser OAuth | | workrail auth status | Check authentication status | | workrail link | Link current repo to a Workrail project | | workrail sync | Sync commits and create entries | | workrail entry add | Create an achievement entry manually | | workrail status | View sync status and linked repos | | workrail autosync enable | Enable automatic syncing | | workrail autosync status | Check autosync status | | workrail autosync disable | Disable automatic syncing | | workrail --version | Show CLI version | | workrail --help | Show all available commands |

Privacy

Workrail syncs metadata only (commit hashes, timestamps, messages). Your source code never leaves your machine. Read more about our privacy practices.

Updating

To update to the latest version:

npm:

npm update -g @workrail/cli

pnpm:

pnpm update -g @workrail/cli

bun:

bun update -g @workrail/cli

Uninstalling

npm:

npm uninstall -g @workrail/cli

pnpm:

pnpm remove -g @workrail/cli

bun:

bun remove -g @workrail/cli

Troubleshooting

Installation fails or binary not found:

• Ensure Node.js 18+ is installed: node --version
• Try reinstalling: npm uninstall -g @workrail/cli && npm install -g @workrail/cli

Authentication issues:

• Run workrail auth login again to re-authenticate
• Check status with workrail auth status

Sync not working:

• Ensure you're in a git repository
• Run workrail link to link the repo first
• Check workrail status to verify repo is linked

Support

• Documentation: workrail.dev/docs
• Email: [email protected]

License

Proprietary - All rights reserved © 2026 AVIATOLABS FZ-LLC