CLI Commands

The ws CLI provides commands for managing tasks, test cases, and workspaces.

Task Commands

List My Tasks

ws task mine

Shows all tasks assigned to you in the configured workspace. Supports filters:

Flag Description
--workspace Override the default workspace
--status Filter by status name or alias
--output Output format: json or table

List Created Tasks

ws task created

Shows all tasks you created. Accepts the same filters as ws task mine.

Output Formats

Table output (default):

KEY        TITLE                STATUS        ASSIGNEE
ENG-142    Fix auth redirect    In Progress   alice
ENG-138    Update docs          Open          bob

JSON output (--output json):

[
  {
    "key": "ENG-142",
    "title": "Fix auth redirect",
    "status": "In Progress",
    "assignee": "alice"
  }
]

Test Commands

List Test Cases

ws test case ls

Lists all test cases in the workspace.

Flag Description
--workspace Override the default workspace
--folder Filter by folder ID
--output Output format: json or table

Get Test Case Details

ws test case get <id>

Shows a specific test case with all its steps. The output includes the test case metadata and the ordered step sequence.

Workspace Commands

List Workspaces

ws workspace ls

Lists all workspaces you have access to.

Workspace Info

ws workspace info [workspace-key]

Shows detailed configuration for a workspace:

  • Available statuses and their order
  • Item types (Task, Bug, Story, etc.)
  • Workflow transitions
  • Workspace settings

If no workspace key is provided, the default from your config is used.

Config Commands

Initialize Config

ws config init

Interactive setup that creates a ws.toml config file. See CLI Configuration for details.

Examples

# List your tasks in the ENG workspace
ws task mine --workspace ENG

# Get tasks as JSON for scripting
ws task mine --output json | jq '.[].key'

# View a specific test case
ws test case get 42

# Check workspace setup
ws workspace info ENG