Installation

Install

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

pnpm add -g @codeworksh/cli

The curl script installs a standalone binary that needs no Node.js, on macOS (Apple silicon) and Linux (arm64, x64, glibc). The pnpm package needs Node.js 24 or later and works on other platforms too.

The curl script installs one codework binary to ~/.codework/bin and adds that folder to your PATH.

Pass flags after sh -s --, as in curl -fsSL https://codework.sh/install | sh -s -- --dev.

Check that it’s on your path:

codework --help

Every command is codework <command>. Add --help to any command to see its flags.

Connect a Model

CodeWork needs access to at least one model provider. Sign in with a subscription:

codework auth login --openai-codex
codework auth login --github-copilot

Or set an API key:

export OPENROUTER_API_KEY="..."
export GEMINI_API_KEY="..."

Credentials from codework auth login are stored in your CodeWork home (~/.codework by default) and refreshed automatically. See Models & Pricing for every provider.

Check what CodeWork can see:

codework auth status --openai-codex
codework models

Where CodeWork Keeps Its Files

Use --home on any command to point CodeWork at a different home.

Update

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

pnpm add -g @codeworksh/cli@latest

Uninstall

For curl, delete ~/.codework/bin/codework and the PATH line the script added to your shell’s startup file.

pnpm remove -g @codeworksh/cli

This leaves ~/.codework in place. Delete it too if you want to remove your sessions, settings, and credentials.