Skip to main content

Keyboard-driven terminal ticket explorer for a tree of markdown briefs.

Project description

tix

Keyboard-driven terminal ticket explorer for a tree of markdown briefs. Linear-like TUI, zero deps beyond the Python stdlib + an optional markdown pager.

LANES                         STATE              CTX
◐ P1 teams-error-mapping      active              74K
○ P0 oauth-rotation-plan      open                —
●    audit-logs-rollout       done                —

Why

  • The filesystem is the database. A ticket is a markdown file. grep, git log, and ls all keep working.
  • No SaaS, no auth, no network. Runs entirely against a local tree.
  • Linear-like keys. j/k, / to filter, Enter to open, p to pick up into a wt lane.
  • Pure reader. tix never writes status: for you. If you want auto-status derivation, wire up your own preload hook (see below).

Install

pipx install tix-cli
# or, in a venv:
pip install tix-cli

Installs one console script: tix.

From source

git clone https://github.com/gitpancake/tix
cd tix
pipx install --editable .

Quickstart

mkdir -p ~/.claude/tickets/spikes
cp $(python -c 'import tix, pathlib; print(pathlib.Path(tix.__file__).parent / "templates" / "_TEMPLATE.md")') \
   ~/.claude/tickets/spikes/my-first-ticket.md
tix

Or point at a project tree:

cd ~/code
tix my-project           # browses ~/code/my-project/.claude/tickets
TICKETS_DIR=./docs/tickets tix

Keys

Key Action
/ j k Move
Ctrl-U Ctrl-D Half page
g G Top / bottom
Enter l Open in glow (or $PAGER)
Esc h Collapse / back
/ Filter
e Edit in $EDITOR
p Pickup → wt <slug>
i Pin status active
d Pin status done
x Pin status cancelled
m Move ticket to area
y Copy slug to clipboard
o Open Linear URL (if linear: set)
r Reload (re-runs preload hook if set)
? Help
q Quit

Schema

A ticket is a markdown file with YAML-ish line-based frontmatter:

---
status: open
priority: P1
area: integrations
linear: PROJ-123
---

# teams-error-mapping

## Context## Acceptance criteria
- [ ]

Full contract: docs/ticket-schema.md.

  • Filename is the slug. teams-error-mapping.md, never PROJ-123.md.
  • Epic = folder. A directory containing _epic.md is an epic; numbered children (01-foo.md, 02-bar.md) are its stories.
  • Status vocab is pinned: active, open, draft, done, cancelled.

Configuration

Env Default Purpose
TICKETS_DIR ~/.claude/tickets Root of the ticket tree
ACTIVE_LANES_FILE ~/.claude/active-lanes.json Optional sidecar map: slug → {path, branch, repo, last_commit}. Read by the TUI; tix never writes it.
LINEAR_WORKSPACE (unset) Slug used to derive linear: URLs (o key)
TIX_PRELOAD_HOOK (unset) Shell command run before launch. See below.
EDITOR vi Used by e
PAGER less Fallback when glow is absent

TICKETS_DIR resolves in this order: explicit env var → ~/.claude/tickets. There is no project-local autodiscovery; pass tix <project> or set TICKETS_DIR explicitly.

Preload hook

tix doesn't write status: — that's deliberate. If you want statuses derived from external signals (live worktrees, feature branches, merged PRs, calendar events, anything), put a script on disk and point at it:

export TIX_PRELOAD_HOOK=~/bin/my-status-sync
tix

The hook runs once before the TUI is drawn. Its stdout/stderr are discarded — curses is about to claim the screen, so the next render is the feedback, not the printed diff. The hook is best-effort: a missing or failing command never blocks launch.

The r key in the TUI re-runs the hook and reloads.

A reference implementation (filesystem + git + gh) lives in gitpancake/.dotfiles as claude/scripts/ticket-status-sync.py — it derives active from live worktrees and done from merged PRs. Copy it, fork it, replace it.

Optional integrations

  • wt — if a wt command is on PATH, the p key suspends curses, runs git fetch && git checkout main && git merge --ff-only && wt <slug>, then resumes.
  • glow — preferred markdown pager for ticket preview. Falls back to $PAGER (default less).
  • gh — used by some preload hooks (not by tix itself).

Non-goals

  • No remote sync, no auth, no web UI.
  • No mouse support.
  • No notifications.
  • No bundled status reconciler — wire your own via TIX_PRELOAD_HOOK.

License

MIT.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tix_cli-0.1.0.tar.gz (23.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tix_cli-0.1.0-py3-none-any.whl (21.2 kB view details)

Uploaded Python 3

File details

Details for the file tix_cli-0.1.0.tar.gz.

File metadata

  • Download URL: tix_cli-0.1.0.tar.gz
  • Upload date:
  • Size: 23.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for tix_cli-0.1.0.tar.gz
Algorithm Hash digest
SHA256 ea6b51498fc30f9073c896205219d1751512bec2f30907d4ee722c3028a84026
MD5 5aa0cf33afdda3cefb9ac2a63a9f4490
BLAKE2b-256 aeb9b13e8c17a7854d65002cdba23067be1d0d77fa959d0234c912cf101dbaf3

See more details on using hashes here.

File details

Details for the file tix_cli-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: tix_cli-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 21.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for tix_cli-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 65e4dbaee8522efb41df2a2c88390868d7f3cdaf7d1ae68a3d9936ce6112015e
MD5 428df376e4dd12f95d21fe025f1119d2
BLAKE2b-256 6c23844ac1b9c5756cb1ff809901bc64bb8a23a1cf5a1aff302917d58c385f47

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page