@obsfx/trekker 1.2.0 → 1.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +69 -6
  2. package/dist/index.js +1387 -13
  3. package/package.json +2 -1
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # Trekker
2
2
 
3
- A CLI issue tracker built for AI coding agents. Stores tasks, epics, and dependencies in a local SQLite database with a built-in kanban board. No server required.
3
+ A CLI issue tracker built for AI coding agents. Stores tasks, epics, and dependencies in a local SQLite database. No server required.
4
4
 
5
5
  ## Install
6
6
 
@@ -24,7 +24,7 @@ My concerns about the future and security of that project led me here. Trekker i
24
24
 
25
25
  What you get:
26
26
  - Task and epic tracking with dependencies
27
- - Built-in kanban board UI with real-time updates
27
+ - Optional kanban board UI available as a [separate package](https://github.com/obsfx/trekker-dashboard)
28
28
  - No special directory required. The .trekker folder stays local to your project.
29
29
  - No hook integrations. Just task management.
30
30
 
@@ -83,6 +83,7 @@ trekker epic create -t <title> [-d <desc>] [-p <0-5>] [-s <status>]
83
83
  trekker epic list [--status <status>]
84
84
  trekker epic show <epic-id>
85
85
  trekker epic update <epic-id> [options]
86
+ trekker epic complete <epic-id> # Complete epic and archive all tasks/subtasks
86
87
  trekker epic delete <epic-id>
87
88
  ```
88
89
 
@@ -122,6 +123,53 @@ trekker dep remove <task-id> <depends-on-id>
122
123
  trekker dep list <task-id>
123
124
  ```
124
125
 
126
+ ### Search
127
+
128
+ Full-text search across epics, tasks, subtasks, and comments using FTS5:
129
+
130
+ ```bash
131
+ trekker search <query> [--type <types>] [--status <status>] [--limit <n>] [--page <n>]
132
+ ```
133
+
134
+ Examples:
135
+ ```bash
136
+ trekker search "authentication" # Search all entities
137
+ trekker search "bug fix" --type task,subtask # Search only tasks and subtasks
138
+ trekker search "login" --type comment --status completed # Search comments in completed items
139
+ ```
140
+
141
+ ### History
142
+
143
+ View audit log of all changes (creates, updates, deletes):
144
+
145
+ ```bash
146
+ trekker history [--entity <id>] [--type <types>] [--action <actions>] [--since <date>] [--until <date>]
147
+ ```
148
+
149
+ Examples:
150
+ ```bash
151
+ trekker history # All events
152
+ trekker history --entity TREK-1 # Events for specific entity
153
+ trekker history --type task --action update # Only task updates
154
+ trekker history --since 2025-01-01 --limit 20 # Events after date
155
+ ```
156
+
157
+ ### List
158
+
159
+ Unified view of all epics, tasks, and subtasks:
160
+
161
+ ```bash
162
+ trekker list [--type <types>] [--status <statuses>] [--priority <levels>] [--sort <fields>]
163
+ ```
164
+
165
+ Examples:
166
+ ```bash
167
+ trekker list # All items, newest first
168
+ trekker list --type task --status in_progress # Active tasks only
169
+ trekker list --priority 0,1 --sort priority:asc # Critical/high priority first
170
+ trekker list --sort title:asc,created:desc # Sort by title, then by date
171
+ ```
172
+
125
173
  ### Web Interface
126
174
 
127
175
  For a visual kanban board, install the separate dashboard package:
@@ -133,13 +181,26 @@ trekker-dashboard -p 3000 # Start dashboard on port 3000
133
181
 
134
182
  The dashboard shows tasks grouped by status and reads from the same `.trekker/trekker.db` database.
135
183
 
136
- ## JSON Output
184
+ ## Claude Code Integration
137
185
 
138
- Add the `--json` flag to any command for structured output:
186
+ For seamless integration with [Claude Code](https://claude.ai/code), install the Trekker plugin:
139
187
 
140
188
  ```bash
141
- trekker --json task list
142
- trekker --json task show TREK-1
189
+ claude /plugin marketplace add obsfx/trekker-claude-code
190
+ claude /plugin install trekker
191
+ ```
192
+
193
+ This gives Claude Code native access to Trekker commands through MCP. The agent can create tasks, update status, and manage dependencies without running CLI commands directly.
194
+
195
+ See [trekker-claude-code](https://github.com/obsfx/trekker-claude-code) for more details.
196
+
197
+ ## TOON Output
198
+
199
+ Add the `--toon` flag to any command for structured output in [TOON format](https://github.com/tooners/toon). TOON is a token-efficient serialization format designed for AI agents, using fewer tokens than JSON while remaining machine-readable:
200
+
201
+ ```bash
202
+ trekker --toon task list
203
+ trekker --toon task show TREK-1
143
204
  ```
144
205
 
145
206
  ## Status Values
@@ -175,6 +236,8 @@ Run `trekker quickstart` to see the full guide with best practices for creating
175
236
 
176
237
  This is my personal workflow for getting the most out of Trekker with AI agents:
177
238
 
239
+ - **Install the Claude Code plugin.** I use [trekker-claude-code](https://github.com/obsfx/trekker-claude-code) to give Claude Code direct access to Trekker through MCP. This way, the agent manages tasks natively without running CLI commands.
240
+
178
241
  - **Always mention Trekker in prompts.** I include "use trekker" in my instructions so the agent knows to track its work.
179
242
 
180
243
  - **Point agents to the quickstart.** I tell the agent it can run `trekker quickstart` to learn how to use Trekker properly. This gives it all the context it needs without me having to explain everything.