i-plane 1.1.0 → 1.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.
- package/AGENTS.md +134 -74
- package/README.md +53 -240
- package/dist/cli.js +65 -64
- package/docs/api-coverage.md +78 -0
- package/package.json +20 -6
package/docs/api-coverage.md
CHANGED
|
@@ -27,8 +27,55 @@ The compatibility target uses the `issues/` routes. The current public
|
|
|
27
27
|
documents `work-items/` instead. A route migration must be verified against the
|
|
28
28
|
target server; do not change paths solely to match a newer documentation release.
|
|
29
29
|
|
|
30
|
+
## What modules and intake are for
|
|
31
|
+
|
|
32
|
+
A module groups work toward a feature, milestone or other goal and may span
|
|
33
|
+
several cycles. A cycle is a time window. Work items can belong to multiple
|
|
34
|
+
modules. A module's lead and members are separate from work item assignees.
|
|
35
|
+
The module status describes its overall planning stage; work item states show
|
|
36
|
+
individual progress. See [Plane's module guide](https://docs.plane.so/core-concepts/modules).
|
|
37
|
+
|
|
38
|
+
Intake is a queue for reports and requests that have not yet been accepted into
|
|
39
|
+
project work. Requests start in Triage with a pending decision. They can be
|
|
40
|
+
accepted, rejected, snoozed or linked to an existing work item as a duplicate.
|
|
41
|
+
This keeps undecided requests out of committed work. See the
|
|
42
|
+
[intake overview](https://docs.plane.so/intake/overview).
|
|
43
|
+
|
|
44
|
+
| Resource | Plane fields | Current CLI support |
|
|
45
|
+
| --- | --- | --- |
|
|
46
|
+
| Module | Name, description, overall status, start/due dates | `module create` with name, `--description`, `--status`, `--start`, `--due` |
|
|
47
|
+
| Module ownership | Lead and members | Available in the API/UI; not set by this CLI |
|
|
48
|
+
| Module contents | Related work items | `module add`, `module issues`; membership can overlap across modules |
|
|
49
|
+
| Intake request | Title, description, priority | `intake create`; `intake update --name`, `--description`, `--priority` |
|
|
50
|
+
| Intake decision | Pending, rejected, snoozed, accepted, duplicate; snooze deadline; duplicate target | `intake update --status`, `--snooze-until`, `--duplicate-of` |
|
|
51
|
+
| Intake work properties | Assignees, labels, due date and other UI properties | Not exposed by intake commands; use normal `update` after acceptance |
|
|
52
|
+
| Intake channels | In-app submissions, public forms, email | CLI submits through the API; it does not configure forms/email |
|
|
53
|
+
|
|
54
|
+
The UI guide and API defaults are not interchangeable. The module guide says
|
|
55
|
+
new modules start in Backlog, while the tested API instance returned `planned`
|
|
56
|
+
when status was omitted. CLI examples therefore specify `--status planned`.
|
|
57
|
+
The UI can choose a work item state while accepting an intake request; the
|
|
58
|
+
current CLI/API acceptance path moves it to the default project state. A normal
|
|
59
|
+
`update --state` can then select a different state.
|
|
60
|
+
|
|
61
|
+
A focused check of the published CLI confirmed that adding a work item to a
|
|
62
|
+
second module preserves its first membership, and that intake acceptance moves
|
|
63
|
+
a request from pending/Triage into the normal Backlog state on the tested
|
|
64
|
+
instance. Temporary check data was deleted.
|
|
65
|
+
|
|
66
|
+
Field references: [module creation](https://developers.plane.so/api-reference/module/add-module),
|
|
67
|
+
[intake properties](https://docs.plane.so/core-concepts/intake), and
|
|
68
|
+
[intake updates](https://developers.plane.so/api-reference/intake-issue/update-intake-issue-detail).
|
|
69
|
+
|
|
30
70
|
## Compatibility details
|
|
31
71
|
|
|
72
|
+
The supported runtime is Node 22.21+ on the 22.x line, or Node 24+. The optional
|
|
73
|
+
proxy dependency, `undici` 8.x, requires Node 22.19 or newer. The fallback based
|
|
74
|
+
on `NODE_USE_ENV_PROXY` requires Node 22.21 or Node 24; the package's `engines`
|
|
75
|
+
range covers both transport paths. Node 20 is not a supported configuration.
|
|
76
|
+
See [Undici support](https://github.com/nodejs/undici#long-term-support) and
|
|
77
|
+
[Node proxy support](https://nodejs.org/api/cli.html#node_use_env_proxy1).
|
|
78
|
+
|
|
32
79
|
Enabling intake on project creation requires a follow-up project PATCH to create
|
|
33
80
|
the queue. A creation flag alone can leave `intake_view=true` without an intake
|
|
34
81
|
record, causing the first submission to fail with HTTP 500. The CLI initializes
|
|
@@ -72,3 +119,34 @@ Reference: [projects](https://developers.plane.so/api-reference/project/add-proj
|
|
|
72
119
|
[cycles](https://developers.plane.so/api-reference/cycle/transfer-cycle-work-items),
|
|
73
120
|
[modules](https://developers.plane.so/api-reference/module/add-module),
|
|
74
121
|
[intake](https://developers.plane.so/api-reference/intake-issue/overview).
|
|
122
|
+
|
|
123
|
+
## Development checks
|
|
124
|
+
|
|
125
|
+
From a repository checkout:
|
|
126
|
+
|
|
127
|
+
```bash
|
|
128
|
+
bun test
|
|
129
|
+
bun run check
|
|
130
|
+
bun run lint
|
|
131
|
+
node scripts/release.mjs
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
The release gate builds and checks the distributable, smoke-tests the command,
|
|
135
|
+
and validates package contents, size and registry availability. Its default run
|
|
136
|
+
does not publish; `--publish` is the publishing path.
|
|
137
|
+
|
|
138
|
+
For live acceptance, build first and use the normal Plane credentials:
|
|
139
|
+
|
|
140
|
+
```bash
|
|
141
|
+
bun run build
|
|
142
|
+
node scripts/acceptance.mjs --live
|
|
143
|
+
node scripts/planning-acceptance.mjs --live
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
The first script creates an epic and nine children, then checks labels,
|
|
147
|
+
assignment, dates, comments, states and archive. The second checks cycles,
|
|
148
|
+
unfinished-work transfer, module membership and the intake lifecycle. Both use
|
|
149
|
+
CLI commands and delete their temporary projects in a `finally` block.
|
|
150
|
+
They space calls to respect the API request budget and take several minutes;
|
|
151
|
+
a forced termination can interrupt cleanup. For a focused change, prefer a
|
|
152
|
+
small targeted live check to repeating both scenarios.
|
package/package.json
CHANGED
|
@@ -1,13 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "i-plane",
|
|
3
|
-
"version": "1.1.
|
|
4
|
-
"description": "CLI
|
|
3
|
+
"version": "1.1.2",
|
|
4
|
+
"description": "Compact Plane CLI for coding agents: project management, issue tracking, cycles, modules and intake.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"license": "MIT",
|
|
7
7
|
"author": "iiiokojiadbi <iiiokojiadbi@yandex.ru>",
|
|
8
|
-
"contributors": [
|
|
9
|
-
"Claude (Anthropic) <noreply@anthropic.com>"
|
|
10
|
-
],
|
|
11
8
|
"repository": {
|
|
12
9
|
"type": "git",
|
|
13
10
|
"url": "git+https://github.com/iiiokojiadbi/i-plane.git"
|
|
@@ -22,7 +19,7 @@
|
|
|
22
19
|
"CLAUDE.md"
|
|
23
20
|
],
|
|
24
21
|
"engines": {
|
|
25
|
-
"node": ">=
|
|
22
|
+
"node": "^22.21.0 || >=24.0.0"
|
|
26
23
|
},
|
|
27
24
|
"packageManager": "bun@1.4.0",
|
|
28
25
|
"scripts": {
|
|
@@ -47,5 +44,22 @@
|
|
|
47
44
|
"markdown-it": "15.0.1",
|
|
48
45
|
"turndown": "7.2.4",
|
|
49
46
|
"turndown-plugin-gfm": "1.0.2"
|
|
47
|
+
},
|
|
48
|
+
"keywords": [
|
|
49
|
+
"plane",
|
|
50
|
+
"plane-cli",
|
|
51
|
+
"plane-so",
|
|
52
|
+
"project-management",
|
|
53
|
+
"issue-tracker",
|
|
54
|
+
"task-management",
|
|
55
|
+
"cli",
|
|
56
|
+
"coding-agent",
|
|
57
|
+
"agent-tools",
|
|
58
|
+
"automation",
|
|
59
|
+
"markdown"
|
|
60
|
+
],
|
|
61
|
+
"homepage": "https://github.com/iiiokojiadbi/i-plane#readme",
|
|
62
|
+
"bugs": {
|
|
63
|
+
"url": "https://github.com/iiiokojiadbi/i-plane/issues"
|
|
50
64
|
}
|
|
51
65
|
}
|