@obsfx/trekker 1.4.0 → 1.5.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.
- package/README.md +20 -1
- package/bin/trekker.js +31 -1
- package/dist/index.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,6 +2,23 @@
|
|
|
2
2
|
|
|
3
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
|
+
## Prerequisites
|
|
6
|
+
|
|
7
|
+
Trekker requires [Bun](https://bun.sh) runtime. It uses `bun:sqlite` for database operations. This is a deliberate choice: `bun:sqlite` is significantly faster than Node.js SQLite drivers, making CLI operations feel instant.
|
|
8
|
+
|
|
9
|
+
**Install Bun:**
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
# macOS/Linux
|
|
13
|
+
curl -fsSL https://bun.sh/install | bash
|
|
14
|
+
|
|
15
|
+
# Windows
|
|
16
|
+
powershell -c "irm bun.sh/install.ps1 | iex"
|
|
17
|
+
|
|
18
|
+
# Or via npm
|
|
19
|
+
npm install -g bun
|
|
20
|
+
```
|
|
21
|
+
|
|
5
22
|
## Install
|
|
6
23
|
|
|
7
24
|
```bash
|
|
@@ -24,6 +41,8 @@ My concerns about the future and security of that project led me here. Trekker i
|
|
|
24
41
|
|
|
25
42
|
What you get:
|
|
26
43
|
- Task and epic tracking with dependencies
|
|
44
|
+
- Full-text search across tasks, epics, subtasks, and comments
|
|
45
|
+
- Unified list view with filtering by type, status, priority, and custom sorting
|
|
27
46
|
- Optional kanban board UI available as a [separate package](https://github.com/obsfx/trekker-dashboard)
|
|
28
47
|
- No special directory required. The .trekker folder stays local to your project.
|
|
29
48
|
- No hook integrations. Just task management.
|
|
@@ -196,7 +215,7 @@ See [trekker-claude-code](https://github.com/obsfx/trekker-claude-code) for more
|
|
|
196
215
|
|
|
197
216
|
## TOON Output
|
|
198
217
|
|
|
199
|
-
Add the `--toon` flag to any command for structured output in [TOON format](https://github.com/
|
|
218
|
+
Add the `--toon` flag to any command for structured output in [TOON format](https://github.com/toon-format/toon). TOON is a token-efficient serialization format designed for AI agents, using fewer tokens than JSON while remaining machine-readable:
|
|
200
219
|
|
|
201
220
|
```bash
|
|
202
221
|
trekker --toon task list
|
package/bin/trekker.js
CHANGED
|
@@ -1,9 +1,39 @@
|
|
|
1
|
-
#!/usr/bin/env
|
|
1
|
+
#!/usr/bin/env node
|
|
2
2
|
|
|
3
3
|
import { existsSync } from "fs";
|
|
4
4
|
import { dirname, resolve } from "path";
|
|
5
5
|
import { fileURLToPath } from "url";
|
|
6
6
|
|
|
7
|
+
// Check if running in Bun runtime
|
|
8
|
+
const isBun = typeof globalThis.Bun !== "undefined";
|
|
9
|
+
|
|
10
|
+
if (!isBun) {
|
|
11
|
+
console.error(`
|
|
12
|
+
Trekker requires Bun runtime.
|
|
13
|
+
|
|
14
|
+
Bun is not installed or you're running this with Node.js.
|
|
15
|
+
Trekker uses bun:sqlite for database operations. This is a deliberate choice:
|
|
16
|
+
bun:sqlite is significantly faster than Node.js SQLite drivers, making CLI
|
|
17
|
+
operations feel instant.
|
|
18
|
+
|
|
19
|
+
To install Bun:
|
|
20
|
+
|
|
21
|
+
macOS/Linux:
|
|
22
|
+
curl -fsSL https://bun.sh/install | bash
|
|
23
|
+
|
|
24
|
+
Windows:
|
|
25
|
+
powershell -c "irm bun.sh/install.ps1 | iex"
|
|
26
|
+
|
|
27
|
+
Or via npm:
|
|
28
|
+
npm install -g bun
|
|
29
|
+
|
|
30
|
+
After installing Bun, run trekker again.
|
|
31
|
+
|
|
32
|
+
Learn more: https://bun.sh
|
|
33
|
+
`);
|
|
34
|
+
process.exit(1);
|
|
35
|
+
}
|
|
36
|
+
|
|
7
37
|
const __dirname = dirname(fileURLToPath(import.meta.url));
|
|
8
38
|
const distPath = resolve(__dirname, "../dist/index.js");
|
|
9
39
|
|
package/dist/index.js
CHANGED
|
@@ -3443,7 +3443,7 @@ function formatItem(item) {
|
|
|
3443
3443
|
// package.json
|
|
3444
3444
|
var package_default = {
|
|
3445
3445
|
name: "@obsfx/trekker",
|
|
3446
|
-
version: "1.
|
|
3446
|
+
version: "1.5.0",
|
|
3447
3447
|
description: "A CLI-based issue tracker built for AI coding agents. Stores tasks, epics, and dependencies in a local SQLite database.",
|
|
3448
3448
|
type: "module",
|
|
3449
3449
|
main: "dist/index.js",
|
package/package.json
CHANGED