pipe-kan 0.29.1 → 0.30.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 +38 -4
- package/dist/pipe-kan.js +694 -18
- package/dist/ui/assets/index-BRqmsBb_.js +56 -0
- package/dist/ui/index.html +1 -1
- package/package.json +2 -2
- package/dist/ui/assets/index-ChnNJHrZ.js +0 -56
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# pipe-kan
|
|
2
2
|
|
|
3
|
-
Local Kanban for [jira-cli](https://github.com/ankitpokhrel/jira-cli)
|
|
3
|
+
Local Kanban for [jira-cli](https://github.com/ankitpokhrel/jira-cli) or [Plane](https://plane.so). Jira write-back still goes through jira-cli. Plane write-back uses the Plane REST API.
|
|
4
4
|
|
|
5
5
|
## Run
|
|
6
6
|
|
|
@@ -16,8 +16,8 @@ First paint is the Fixture. If `jira` is on PATH, the process then Refresh-es fr
|
|
|
16
16
|
|
|
17
17
|
The published CLI is on npm. From a clone: `bun run build && bun dist/pipe-kan.js`.
|
|
18
18
|
|
|
19
|
-
- Left: All stories and All epics. Center: Cards (one Column per status
|
|
20
|
-
- Drop a Card on a Column to Move (`jira issue move`).
|
|
19
|
+
- Left: All stories and All epics (Plane: modules in that left rail). Center: Cards (one Column per status; Plane also keeps empty workflow states). Right: Open URL; remote Jira is a link, not an iframe.
|
|
20
|
+
- Drop a Card on a Column to Move (`jira issue move`, or Plane `PATCH` work-item state).
|
|
21
21
|
- Column `+` or Cmd+K **Create issue** opens a composer. **Create with AI** seeds the Agent to draft and call `create_issue` after approval.
|
|
22
22
|
- Double-click a Card or Open-pane **Edit** to change summary, description, and labels (`jira issue edit`).
|
|
23
23
|
- Drag a Column to change status order. The order is stored locally and kept after Refresh.
|
|
@@ -38,6 +38,36 @@ bunx pipe-kan
|
|
|
38
38
|
|
|
39
39
|
Scope flags start empty (jira-cli's one Project). Add `-a you@work.com` or `-s~Done` if you want a tighter list, then Refresh. More than one Project key: `--projects` below.
|
|
40
40
|
|
|
41
|
+
## Plane
|
|
42
|
+
|
|
43
|
+
Plane is an alternate backend. Jira stays the default. Auth is environment-only — do not put the key in flags, git, or the Scope field.
|
|
44
|
+
|
|
45
|
+
```sh
|
|
46
|
+
export PLANE_API_KEY=...
|
|
47
|
+
# optional; default is this self-hosted instance
|
|
48
|
+
export PLANE_HOST=https://plane.tail48fe8.ts.net
|
|
49
|
+
bunx pipe-kan --plane --projects APH,PULSE,PKAN,PUI,DEC
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
| Flag / env | Default | Role |
|
|
53
|
+
| --- | --- | --- |
|
|
54
|
+
| `--plane` | off | use Plane instead of jira-cli |
|
|
55
|
+
| `--workspace` | `personal` | Plane workspace slug (`--workspace team` or `PLANE_WORKSPACE`) |
|
|
56
|
+
| `--projects APH,PULSE` | all workspace projects | Plane project identifiers |
|
|
57
|
+
| `PLANE_API_KEY` | (required in Plane mode) | personal access token (`X-API-Key`) |
|
|
58
|
+
| `PLANE_HOST` | `https://plane.tail48fe8.ts.net` | Plane origin; API is `{host}/api/v1` |
|
|
59
|
+
|
|
60
|
+
Same `--projects` style as Jira: comma-separated, trimmed, uppercased. The header **Scope flags** field accepts the same string, then **Refresh**.
|
|
61
|
+
|
|
62
|
+
On Refresh:
|
|
63
|
+
|
|
64
|
+
- Work items become Cards. Workflow states become Columns (including empty states, so you can drop onto them).
|
|
65
|
+
- Modules fill the left rail like Epics. Selecting a module shows its work items.
|
|
66
|
+
- Label `needs-input` is a warning badge on the Card.
|
|
67
|
+
- Drop a Card on a Column PATCHes that work item's state. Same-Column drop is still a no-op.
|
|
68
|
+
|
|
69
|
+
Create and Edit use Plane REST when `--plane` is set. Pulse, Plane Pro, scraping, and SQL workspace moves are out of scope.
|
|
70
|
+
|
|
41
71
|
## Multiple projects
|
|
42
72
|
|
|
43
73
|
Default Scope is one Project — jira-cli's `jira init` project. To list more than one Project key:
|
|
@@ -98,11 +128,15 @@ Pipe is the first Board. Refresh and Move still go through `jira` when it is on
|
|
|
98
128
|
| `JIRA_BIN` | `jira` | binary name or path |
|
|
99
129
|
| `JIRA_CONFIG_FILE` | jira-cli default | set only for Fake Jira |
|
|
100
130
|
| `JIRA_API_TOKEN` | jira-cli default | Work Jira token if needed |
|
|
131
|
+
| `PLANE_API_KEY` | (none) | Plane token; required with `--plane` |
|
|
132
|
+
| `PLANE_HOST` | `https://plane.tail48fe8.ts.net` | Plane origin |
|
|
133
|
+
| `PLANE_WORKSPACE` | `personal` | default workspace if `--workspace` is omitted |
|
|
101
134
|
|
|
102
135
|
## Limits
|
|
103
136
|
|
|
104
|
-
-
|
|
137
|
+
- Jira write-back is `jira issue move`, `jira issue create`, and `jira issue edit`. Intra-column rank is not persisted.
|
|
105
138
|
- Never a direct Jira REST Write-back.
|
|
139
|
+
- Plane write-back is Plane REST (`PATCH` work item state / create / edit). The key stays in `PLANE_API_KEY`.
|
|
106
140
|
- Work Jira needs `jira` on PATH and a token. This repo does not ship one.
|
|
107
141
|
|
|
108
142
|
## Check
|