@takemo101/mikan 0.0.1 → 0.0.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 +59 -3
- package/dist/bin.js +1904 -1073
- package/package.json +13 -1
package/README.md
CHANGED
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
# @takemo101/mikan
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
mikan is a tiny local-first Issue board for AI-assisted development. It stores Issues as Markdown files under `.mikan/` and exposes the same board through a CLI, keyboard-first TUI, stdio MCP server, and polling watcher.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
4
6
|
|
|
5
7
|
```sh
|
|
6
8
|
npm install -g @takemo101/mikan
|
|
@@ -9,6 +11,60 @@ mikan add "First Issue"
|
|
|
9
11
|
mikan tui
|
|
10
12
|
```
|
|
11
13
|
|
|
12
|
-
|
|
14
|
+
mikan is currently built for Bun-based execution. The npm package installs the `mikan` binary.
|
|
15
|
+
|
|
16
|
+
## What it provides
|
|
17
|
+
|
|
18
|
+
- **Markdown source of truth**: each Issue is a file such as `.mikan/ready/MIK-001.md`.
|
|
19
|
+
- **Primitive CLI commands**: `init`, `add`, `list`, `show`, `update`, `move`, `append`, `tui`, `watch`, `mcp`, `skills`.
|
|
20
|
+
- **Keyboard TUI**: board-first flow with detail view, Note modal, Move shortcuts, and Archive confirmation.
|
|
21
|
+
- **MCP server**: stdio tools for agents: `get_board`, `list_issues`, `get_issue`, `create_issue`, `update_issue`, `move_issue`, `append_issue`.
|
|
22
|
+
- **Agent setup**: register the MCP server or install agent guidance for common AI agents.
|
|
23
|
+
- **Watch hooks**: optional local automation on Status entry/transition.
|
|
24
|
+
|
|
25
|
+
## Quickstart
|
|
26
|
+
|
|
27
|
+
```sh
|
|
28
|
+
mikan init
|
|
29
|
+
mikan add "Prototype dispatcher" --status ready --label automation
|
|
30
|
+
mikan list
|
|
31
|
+
mikan show MIK-001
|
|
32
|
+
mikan tui
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## TUI columns
|
|
36
|
+
|
|
37
|
+
`mikan tui --columns <auto|2|3|4|5>` (default `auto`) controls how many Status Columns the board shows at once. `auto` derives between 2 and 5 visible Columns from terminal width and keeps the sliding viewport. Fixed values pin an explicit count:
|
|
38
|
+
|
|
39
|
+
```sh
|
|
40
|
+
mikan tui --columns auto
|
|
41
|
+
mikan tui --columns 2
|
|
42
|
+
mikan tui --columns 3
|
|
43
|
+
mikan tui --columns 4
|
|
44
|
+
mikan tui --columns 5
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
The option changes only how many Columns are visible at once; it never changes configured Statuses or Issue files.
|
|
48
|
+
|
|
49
|
+
## Agent setup
|
|
50
|
+
|
|
51
|
+
mikan wires into AI coding agents two independent ways. Neither models agents or adds a runtime: mikan stays **stdio MCP only** — no HTTP server, port, auth, scheduler, or workflow engine.
|
|
52
|
+
|
|
53
|
+
- `mikan mcp add --agent <agent>` registers the stdio MCP server in the agent's MCP config. Agents: `pi`, `antigravity`, `jcode`, `claude-code`, `opencode`, `codex`.
|
|
54
|
+
- `mikan skills add --agent <agent>` installs a small mikan `SKILL.md` that teaches the agent to drive the board through the MCP tools. Agents: `claude-code`, `opencode`, `codex`. This is **separate** from MCP registration — installing skills never changes MCP config.
|
|
55
|
+
|
|
56
|
+
```sh
|
|
57
|
+
mikan mcp add --agent claude-code
|
|
58
|
+
mikan mcp add --agent opencode --no-global
|
|
59
|
+
mikan mcp add --agent codex # global only
|
|
60
|
+
mikan skills add --agent claude-code
|
|
61
|
+
mikan mcp llms # incur-backed discovery manifest
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
`mikan mcp llms` prints incur's manifest for agents that read it directly; it does not install (use `mikan mcp add` for that). Passing `--agent` to `mikan mcp llms` is rejected and points to `mikan mcp add`.
|
|
65
|
+
|
|
66
|
+
## More information
|
|
67
|
+
|
|
68
|
+
See the repository README for full CLI examples, TUI keys, config format, design principles, and limitations:
|
|
13
69
|
|
|
14
|
-
|
|
70
|
+
https://github.com/takemo101/mikan
|