> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ticket-rs.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> Overview of the tk command-line interface

`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:

<Tabs>
  <Tab title="compact (default)">
    Single-line per item, optimized for scripting:

    ```
    ○ tk-abc123 [● P1] [feature] - Add user authentication
    ○ tk-def456 [○ P2] [task] - Set up database
    ```
  </Tab>

  <Tab title="table">
    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
    ```
  </Tab>

  <Tab title="json">
    Machine-parseable JSON:

    ```json theme={null}
    [
      {
        "id": "tk-abc123",
        "status": "open",
        "priority": 1,
        "type": "feature",
        "title": "Add user authentication"
      }
    ]
    ```
  </Tab>
</Tabs>

***

## Status Symbols

In compact output, status is shown with symbols:

| Symbol | Status       |
| ------ | ------------ |
| `○`    | open         |
| `◐`    | in\_progress |
| `●`    | closed       |
| `⊗`    | blocked      |
| `◇`    | deferred     |

***

## Command Categories

### [Core Commands](/cli-reference/commands#core-commands)

| Command                                          | Description                                             |
| ------------------------------------------------ | ------------------------------------------------------- |
| [`tk init`](/cli-reference/commands#tk-init)     | Initialize ticket tracking in a directory               |
| [`tk create`](/cli-reference/commands#tk-create) | Create a new issue                                      |
| [`tk show`](/cli-reference/commands#tk-show)     | Show issue details                                      |
| [`tk list`](/cli-reference/commands#tk-list)     | List issues with optional filters                       |
| [`tk update`](/cli-reference/commands#tk-update) | Update an issue                                         |
| [`tk close`](/cli-reference/commands#tk-close)   | Close an issue                                          |
| [`tk delete`](/cli-reference/commands#tk-delete) | Delete an issue (move to archive or permanently remove) |
| [`tk edit`](/cli-reference/commands#tk-edit)     | Open an issue in your editor                            |

### [Workflow Commands](/cli-reference/commands#workflow-commands)

| Command                                            | Description                                        |
| -------------------------------------------------- | -------------------------------------------------- |
| [`tk claim`](/cli-reference/commands#tk-claim)     | Mark an issue as in\_progress, show unblocked work |
| [`tk resolve`](/cli-reference/commands#tk-resolve) | Close an issue and show what work is now unblocked |
| [`tk ready`](/cli-reference/commands#tk-ready)     | Show issues ready to work on (no open blockers)    |
| [`tk start`](/cli-reference/commands#tk-claim)     | Alias for `tk claim`                               |
| [`tk board`](/cli-reference/commands#tk-board)     | Interactive kanban board (TUI)                     |

### [Dependency Commands](/cli-reference/commands#core-commands)

| Command                                                  | Description                                 |
| -------------------------------------------------------- | ------------------------------------------- |
| [`tk dep add`](/cli-reference/commands#tk-dep-add)       | Add a dependency between issues             |
| [`tk dep remove`](/cli-reference/commands#tk-dep-remove) | Remove a dependency                         |
| [`tk dep tree`](/cli-reference/commands#tk-dep-tree)     | Show dependency tree for an issue           |
| [`tk dep list`](/cli-reference/commands#tk-dep-list)     | List dependencies or dependents of an issue |
| [`tk dep cycles`](/cli-reference/commands#tk-dep-cycles) | Detect dependency cycles in the graph       |

### [Search Commands](/cli-reference/commands#search-commands)

| Command                                                  | Description                          |
| -------------------------------------------------------- | ------------------------------------ |
| [`tk search`](/cli-reference/commands#tk-search)         | Search issues using BM25 text search |
| [`tk similar`](/cli-reference/commands#tk-similar)       | Find issues similar to a given issue |
| [`tk duplicates`](/cli-reference/commands#tk-duplicates) | Find and manage duplicate issues     |
| [`tk grep`](/cli-reference/commands#tk-grep)             | Grep issue content using regex       |

### [AI Commands](/cli-reference/commands#ai--analytics-commands)

| Command                                              | Description                                            |
| ---------------------------------------------------- | ------------------------------------------------------ |
| [`tk prime`](/cli-reference/commands#tk-prime)       | Output AI-optimized workflow context                   |
| [`tk triage`](/cli-reference/commands#tk-triage)     | Unified AI triage with recommendations                 |
| [`tk priority`](/cli-reference/commands#tk-priority) | Get PageRank-based priority recommendations            |
| [`tk next`](/cli-reference/commands#tk-next)         | Get single top recommendation                          |
| [`tk plan`](/cli-reference/commands#tk-plan)         | Get parallel execution plan                            |
| [`tk stacks`](/cli-reference/commands#tk-stacks)     | Detect linear dependency stacks (Graphite-style)       |
| [`tk insights`](/cli-reference/commands#tk-insights) | Get graph analytics                                    |
| [`tk stats`](/cli-reference/commands#tk-stats)       | Show statistics                                        |
| [`tk graph`](/cli-reference/commands#tk-graph)       | Visualize the dependency graph                         |
| [`tk standup`](/cli-reference/commands#tk-standup)   | Generate standup report with git history and analytics |

### [Git Commands](/cli-reference/commands#git-commands)

| Command                                              | Description                                              |
| ---------------------------------------------------- | -------------------------------------------------------- |
| [`tk diff`](/cli-reference/commands#tk-diff)         | Show ticket differences between branches or time periods |
| [`tk cache`](/cli-reference/commands#tk-cache)       | Manage analytics cache (info, clear, rebuild)            |
| [`tk worktree`](/cli-reference/commands#tk-worktree) | Manage git worktrees with shared tickets                 |

### [Integration Commands](/cli-reference/commands#integration-commands)

| Command                                                        | Description                                 |
| -------------------------------------------------------------- | ------------------------------------------- |
| [`tk github sync`](/cli-reference/commands#tk-github-sync)     | Sync issues with GitHub Issues              |
| [`tk github status`](/cli-reference/commands#tk-github-status) | Show GitHub sync status                     |
| [`tk linear sync`](/cli-reference/commands#tk-linear-sync)     | Sync issues with Linear                     |
| [`tk linear status`](/cli-reference/commands#tk-linear-status) | Show Linear sync status                     |
| [`tk linear teams`](/cli-reference/commands#tk-linear-teams)   | List available Linear teams                 |
| [`tk claude sync`](/cli-reference/commands#tk-claude-sync)     | Sync issues with Claude Code tasks          |
| [`tk claude status`](/cli-reference/commands#tk-claude-status) | Show Claude sync status and current session |

### [Admin Commands](/cli-reference/commands#admin-commands)

| Command                                                      | Description                                               |
| ------------------------------------------------------------ | --------------------------------------------------------- |
| [`tk config`](/cli-reference/commands#tk-config)             | Manage configuration                                      |
| [`tk setup claude`](/cli-reference/commands#tk-setup-claude) | Set up Claude Code integration                            |
| [`tk hooks`](/cli-reference/commands#tk-hooks)               | Manage git hooks                                          |
| [`tk doctor`](/cli-reference/commands#tk-doctor)             | Check installation health                                 |
| [`tk validate`](/cli-reference/commands#tk-validate)         | Validate issue database integrity                         |
| [`tk lint`](/cli-reference/commands#tk-lint)                 | Lint all ticket files                                     |
| [`tk rules`](/cli-reference/commands#tk-rules)               | Check issues against custom rules (`.tickets/rules.toml`) |
| [`tk serve`](/cli-reference/commands#tk-serve)               | Start a local HTTP server with a kanban board view        |
| [`tk hello`](/cli-reference/commands#tk-hello)               | Interactive onboarding and preferences setup              |

***

## Getting Help

Get help for any command:

```bash theme={null}
# General help
tk help

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