aglit 0.1.1 → 0.1.3
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 +99 -0
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,99 @@
|
|
|
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
|
+
Local development from this repository:
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
# in packages/cli
|
|
26
|
+
bun run build
|
|
27
|
+
bun link
|
|
28
|
+
|
|
29
|
+
# now available in your shell
|
|
30
|
+
aglit --help
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
Optional: in another project directory, link it as a dependency:
|
|
34
|
+
|
|
35
|
+
```bash
|
|
36
|
+
bun link aglit
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
## Quick start
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
# from your repository
|
|
43
|
+
aglit init --prefix AGL
|
|
44
|
+
|
|
45
|
+
# create a project
|
|
46
|
+
aglit project new "Release process cleanup"
|
|
47
|
+
|
|
48
|
+
# create an issue (linked to a project by slug)
|
|
49
|
+
aglit new --project release-process-cleanup --priority high "Fix publish auth flow"
|
|
50
|
+
|
|
51
|
+
# list work
|
|
52
|
+
aglit list
|
|
53
|
+
aglit projects
|
|
54
|
+
|
|
55
|
+
# validate files and references
|
|
56
|
+
aglit check
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
## Commands
|
|
60
|
+
|
|
61
|
+
```text
|
|
62
|
+
aglit init [--prefix <value>]
|
|
63
|
+
aglit new [--status <value>] [--priority <value>] [--project <slug>] [--prefix <value>] <title>
|
|
64
|
+
aglit list [--status <value>] [--project <slug>] [--group status|none]
|
|
65
|
+
aglit projects [--status <value>]
|
|
66
|
+
aglit project new [--status <value>] [--priority <value>] [--slug <value>] <title>
|
|
67
|
+
aglit check
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
- `init`: creates `.aglit/` layout and saves `issuePrefix` in `.aglit/config.json`.
|
|
71
|
+
- `new`: creates `.aglit/issues/<PREFIX-N>.md`.
|
|
72
|
+
- `project new`: creates `.aglit/projects/<slug>.md`.
|
|
73
|
+
- `list`: prints a status board by default (`--group status`) or a flat list (`--group none`).
|
|
74
|
+
- `projects`: lists projects with issue counts.
|
|
75
|
+
- `check`: validates schemas, IDs, status/priority values, and project references.
|
|
76
|
+
|
|
77
|
+
## Data layout
|
|
78
|
+
|
|
79
|
+
```text
|
|
80
|
+
.aglit/
|
|
81
|
+
config.json
|
|
82
|
+
issues/
|
|
83
|
+
AGL-1.md
|
|
84
|
+
projects/
|
|
85
|
+
release-process-cleanup.md
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
The CLI searches upward from your current directory to find the workspace root
|
|
89
|
+
that contains `.aglit/`, so you can run commands from nested folders.
|
|
90
|
+
|
|
91
|
+
## Allowed values
|
|
92
|
+
|
|
93
|
+
- Status: `inbox`, `planned`, `active`, `blocked`, `done`, `canceled`
|
|
94
|
+
- Priority: `none`, `low`, `medium`, `high`
|
|
95
|
+
|
|
96
|
+
## Notes
|
|
97
|
+
|
|
98
|
+
- If no config exists, `aglit new --prefix ABC "..."` will initialize and store the prefix.
|
|
99
|
+
- 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.
|
|
3
|
+
"version": "0.1.3",
|
|
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",
|