Installation
ticket (tk) has a single-file Bash core with no runtime dependencies. Plugins are optional; install only what you need.
Quick Install¶
Clone the repository and run the modular installer:
git clone https://github.com/msampathkumar/ticket.git
cd ticket
# Full Suite (CLI + Web UI + Agent Skill) — default
./install.sh --full
Binaries are installed to ~/.local/bin/ (override with BIN_DIR). Ensure that directory is on your $PATH.
Download a release¶
The core CLI is attached to every GitHub release as a single file, so no clone is needed:
mkdir -p ~/.local/bin
curl -fsSL https://github.com/msampathkumar/ticket/releases/latest/download/tk -o ~/.local/bin/tk
chmod +x ~/.local/bin/tk
tk version
| Asset | Contents |
|---|---|
tk |
The core CLI script |
tk-core.zip |
ticket, LICENSE, INSTALL.md |
SHA256SUMS |
Checksums for tk and tk-core.zip |
To install from the zip instead:
curl -fsSL https://github.com/msampathkumar/ticket/releases/latest/download/tk-core.zip -o /tmp/tk-core.zip
unzip -o /tmp/tk-core.zip -d /tmp/tk-core
mkdir -p ~/.local/bin && cp /tmp/tk-core/ticket ~/.local/bin/tk && chmod +x ~/.local/bin/tk
tk version
Verify downloads in the download directory with sha256sum -c --ignore-missing SHA256SUMS (macOS: shasum -a 256 -c --ignore-missing SHA256SUMS). Release assets contain the core only; use ./install.sh for the Web UI and plugins.
Requirements¶
Core CLI: Bash 3.2+ and standard Unix tools (awk, sed, grep, find, mkdir, date) on macOS or Linux. Python and Node are not used.
| Optional tool | Used for |
|---|---|
jq |
tk query <filter> (unfiltered tk query works without it) |
rg (ripgrep) |
Faster tk find; grep is used otherwise |
git |
Sharing tickets; default assignee from git config user.name |
Installation Flags¶
Flags accumulate, so any combination works (e.g. ./install.sh --core --github):
| Flag | Installs | Requires |
|---|---|---|
--core, -c |
Core tk CLI |
Bash 3.2+ |
--webui, -w |
Web UI plugin (tk webui) in a local .venv |
Python 3.9+ with uv or pip |
--skill, -s |
Agent skill to ~/.agents/skills/tk/SKILL.md |
None |
--github, -g |
GitHub import plugin (tk github) |
gh (authenticated), jq |
--scion-taskforce, -t |
SCION Task Force plugin (tk scion-taskforce) |
Python 3.9+, scion CLI |
--full, -f |
(Default) Core, Web UI and Agent Skill | Python 3.9+ (for the Web UI) |
--all |
Everything above | All of the above |