CLI Installation

The ws command-line tool lets you manage tasks, test cases, and workspaces directly from the terminal.

Download

Download the ws binary for your platform from the releases page. It's a standalone binary with no dependencies.

Build from Source

Requirements: Go 1.25+

# From the windshift repository
cd cmd/ws
go build -o ws .

Move the binary to your PATH:

# Linux / macOS
sudo mv ws /usr/local/bin/

# Or add to a local bin directory
mv ws ~/.local/bin/

Verify Installation

ws --help

You should see the available commands and global flags.

Initial Setup

Configure the CLI with your Windshift server:

ws config init

This interactive command prompts for:

  1. Server URL - The URL of your Windshift instance (e.g., https://windshift.example.com)
  2. API Token - Your personal API token (generate one from your Windshift profile)
  3. Default Workspace - The workspace key to use when none is specified
  4. Status Aliases - Optional shortcuts for status names (e.g., done=To Review)

The configuration is saved to ./ws.toml (project-level) or ~/.config/ws/config.toml (global).

What's Next