Overview

tk is the command-line interface for ticket-rs. It’s a single binary with no runtime dependencies.

Global Options

These options are available on all commands:

Option	Description
`-C, --dir <DIR>`	Working directory (default: current)
`-f, --format <FORMAT>`	Output format: `compact`, `table`, or `json`
`-h, --help`	Print help
`-V, --version`	Print version

Output Formats

tk supports three output formats:

compact (default)
table
json

Single-line per item, optimized for scripting:

○ tk-abc123 [● P1] [feature] - Add user authentication
○ tk-def456 [○ P2] [task] - Set up database

Human-readable table format:

ID          Status  Priority  Type     Title
──────────  ──────  ────────  ───────  ─────────────────────
tk-abc123   open    P1        feature  Add user authentication
tk-def456   open    P2        task     Set up database

Machine-parseable JSON:

[
  {
    "id": "tk-abc123",
    "status": "open",
    "priority": 1,
    "type": "feature",
    "title": "Add user authentication"
  }
]

Status Symbols

In compact output, status is shown with symbols:

Symbol	Status
`○`	open
`◐`	in_progress
`●`	closed
`⊗`	blocked
`◇`	deferred

Command Categories

Core Commands

Command	Description
`tk init`	Initialize ticket tracking in a directory
`tk create`	Create a new issue
`tk show`	Show issue details
`tk list`	List issues with optional filters
`tk update`	Update an issue
`tk close`	Close an issue

Workflow Commands

Command	Description
`tk launch`	Mark an issue as in_progress, show unblocked work
`tk resolve`	Close an issue and show what work is now unblocked
`tk ready`	Show issues ready to work on (no open blockers)
`tk start`	Alias for `tk launch`

Dependency Commands

Command	Description
`tk dep add`	Add a dependency between issues
`tk dep remove`	Remove a dependency
`tk dep tree`	Show dependency tree for an issue
`tk dep list`	List dependencies or dependents of an issue
`tk dep cycles`	Detect dependency cycles in the graph

Search Commands

Command	Description
`tk search`	Search issues using TF-IDF text search
`tk similar`	Find issues similar to a given issue
`tk duplicates`	Find and manage duplicate issues
`tk grep`	Grep issue content using regex

AI Commands

Command	Description
`tk prime`	Output AI-optimized workflow context
`tk triage`	Unified AI triage with recommendations
`tk priority`	Get PageRank-based priority recommendations
`tk next`	Get single top recommendation
`tk plan`	Get parallel execution plan
`tk insights`	Get graph analytics
`tk stats`	Show statistics

Export & Maintenance

Command	Description
`tk export`	Export issues to JSONL format
`tk compact`	Compact closed issues into CHANGELOG.md
`tk orphan`	Find orphaned issues in git history

Git Worktree Commands

Command	Description
`tk worktree`	Manage git worktrees with shared tickets

Sync Commands

Command	Description
`tk github sync`	Sync issues with GitHub Issues
`tk github status`	Show GitHub sync status
`tk linear sync`	Sync issues with Linear
`tk linear status`	Show Linear sync status
`tk linear teams`	List available Linear teams

Admin Commands

Command	Description
`tk config`	Manage configuration
`tk setup claude`	Set up Claude Code integration
`tk hooks`	Manage git hooks
`tk doctor`	Check installation health
`tk validate`	Validate issue database integrity
`tk lint`	Lint all ticket files
`tk onboard`	Display onboarding snippet for AGENTS.md
`tk demo`	Create demo issues

Getting Help

Get help for any command:

# General help
tk help

# Help for a specific command
tk help create
tk help dep
tk help dep add

Getting Started

CLI Reference

Integrations

Global Options

Output Formats

Status Symbols

Command Categories

Core Commands

Workflow Commands

Dependency Commands

Search Commands

AI Commands

Export & Maintenance

Git Worktree Commands

Sync Commands

Admin Commands

Getting Help

Getting Started

CLI Reference

Integrations

​Global Options

​Output Formats

​Status Symbols

​Command Categories

​Getting Help

Global Options

Output Formats

Status Symbols

Command Categories

Getting Help