note-ticket
v0.1.6
Published
Markdown-frontmatter ticket tracker: `ticket` CLI plus a TicketManager library API
Maintainers
Readme
note-ticket
A git-backed ticket tracker whose tickets are plain markdown files with YAML frontmatter,
stored at <git-repo-root>/_tickets. It ships two surfaces:
ticket— the CLI — create, list, query and graph tickets from a shell.note-ticket— the npm library — the same operations as a typedTicketManagerAPI, for tools that would otherwise shell out.
Both write byte-identical files, so a repo can be driven by either or both.
ticket create "Rework the importer" --tags backend
ticket ls
ticket query 'select(.status == "open")'import { FileTicketManager } from "note-ticket";
const manager = FileTicketManager.forRepository();
const ticket = manager.create({ title: "Rework the importer", tags: "backend" });
manager.setStatus(ticket.id, "in_progress");Install
# npm — the library, and the `ticket` CLI on your bin path
npm install note-ticket
# From a git checkout (auto-rebuilds on git pull)
git clone <repo> && cd note-ticket && ln -s "$PWD/ticket" ~/.local/bin/ticketnpm is the only place this package is published; there is no Homebrew, AUR or other distro package.
The CLI needs node and git at runtime (plus a POSIX shell for the launcher); jq only
for ticket query <jq-filter>. Details, and what needs npm when, are in
docs/cli.md.
Documentation
| Document | Contents |
|---|---|
| docs/cli.md | Full CLI reference: commands, ids, dependency graph, errors, scripting. |
| docs/npm-library.md | Library API: TicketManager, Ticket, DepGraph, the error types, and the guarantees. |
| CHANGELOG.md | Release history. |
License
Thorg Core License, Version 1.0 (ThorgCL-1.0). Portions derived from wedow/ticket under MIT — see THIRD_PARTY_LICENSES.md.
