aglit 0.1.1 → 0.1.2

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 (2) hide show
  1. package/README.md +82 -0
  2. package/package.json +2 -2
package/README.md ADDED
@@ -0,0 +1,82 @@
1
+ # aglit
2
+
3
+ AGLIT is a file-based issue and project tracker for code repositories.
4
+
5
+ It stores data in a local `.aglit/` directory, so you can track work in Markdown,
6
+ keep everything in git, and avoid external services.
7
+
8
+ ## Install
9
+
10
+ ```bash
11
+ bun add -g aglit
12
+ # or
13
+ npm install -g aglit
14
+ ```
15
+
16
+ Run without installing:
17
+
18
+ ```bash
19
+ bunx aglit@latest --help
20
+ ```
21
+
22
+ ## Quick start
23
+
24
+ ```bash
25
+ # from your repository
26
+ aglit init --prefix AGL
27
+
28
+ # create a project
29
+ aglit project new "Release process cleanup"
30
+
31
+ # create an issue (linked to a project by slug)
32
+ aglit new --project release-process-cleanup --priority high "Fix publish auth flow"
33
+
34
+ # list work
35
+ aglit list
36
+ aglit projects
37
+
38
+ # validate files and references
39
+ aglit check
40
+ ```
41
+
42
+ ## Commands
43
+
44
+ ```text
45
+ aglit init [--prefix <value>]
46
+ aglit new [--status <value>] [--priority <value>] [--project <slug>] [--prefix <value>] <title>
47
+ aglit list [--status <value>] [--project <slug>] [--group status|none]
48
+ aglit projects [--status <value>]
49
+ aglit project new [--status <value>] [--priority <value>] [--slug <value>] <title>
50
+ aglit check
51
+ ```
52
+
53
+ - `init`: creates `.aglit/` layout and saves `issuePrefix` in `.aglit/config.json`.
54
+ - `new`: creates `.aglit/issues/<PREFIX-N>.md`.
55
+ - `project new`: creates `.aglit/projects/<slug>.md`.
56
+ - `list`: prints a status board by default (`--group status`) or a flat list (`--group none`).
57
+ - `projects`: lists projects with issue counts.
58
+ - `check`: validates schemas, IDs, status/priority values, and project references.
59
+
60
+ ## Data layout
61
+
62
+ ```text
63
+ .aglit/
64
+ config.json
65
+ issues/
66
+ AGL-1.md
67
+ projects/
68
+ release-process-cleanup.md
69
+ ```
70
+
71
+ The CLI searches upward from your current directory to find the workspace root
72
+ that contains `.aglit/`, so you can run commands from nested folders.
73
+
74
+ ## Allowed values
75
+
76
+ - Status: `inbox`, `planned`, `active`, `blocked`, `done`, `canceled`
77
+ - Priority: `none`, `low`, `medium`, `high`
78
+
79
+ ## Notes
80
+
81
+ - If no config exists, `aglit new --prefix ABC "..."` will initialize and store the prefix.
82
+ - Project linkage uses `projectId` internally; use project slug on the CLI via `--project`.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "aglit",
3
- "version": "0.1.1",
3
+ "version": "0.1.2",
4
4
  "type": "module",
5
5
  "main": "./dist/index.js",
6
6
  "module": "./dist/index.js",
@@ -14,7 +14,7 @@
14
14
  "bin": {
15
15
  "aglit": "./dist/index.js"
16
16
  },
17
- "files": ["dist"],
17
+ "files": ["dist", "README.md"],
18
18
  "scripts": {
19
19
  "build": "bun build src/index.ts --outdir dist --target bun --format esm --sourcemap --external @stricli/core --banner '#!/usr/bin/env bun\n' && tsgo -p tsconfig.json --emitDeclarationOnly",
20
20
  "prepack": "bun run build",