@takemo101/mikan 0.0.3 → 0.0.4
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 +8 -3
- package/dist/bin.js +999 -164
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -16,9 +16,10 @@ mikan is currently built for Bun-based execution. The npm package installs the `
|
|
|
16
16
|
## What it provides
|
|
17
17
|
|
|
18
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`.
|
|
19
|
+
- **Primitive CLI commands**: `init`, `add`, `list`, `show`, `update`, `move`, `append`, `github`, `tui`, `watch`, `mcp`, `skills`.
|
|
20
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`.
|
|
21
|
+
- **MCP server**: stdio tools for agents: `get_board`, `list_issues`, `get_issue`, `create_issue`, `update_issue`, `move_issue`, `append_issue`, `mirror_issue_to_github`, `push_github_mirror`.
|
|
22
|
+
- **GitHub Mirror**: explicit one-way publication from local Markdown Issues to GitHub Issues.
|
|
22
23
|
- **Agent setup**: register the MCP server or install agent guidance for common AI agents.
|
|
23
24
|
- **Watch hooks**: optional local automation on Status entry/transition.
|
|
24
25
|
|
|
@@ -46,12 +47,16 @@ mikan tui --columns 5
|
|
|
46
47
|
|
|
47
48
|
The option changes only how many Columns are visible at once; it never changes configured Statuses or Issue files.
|
|
48
49
|
|
|
50
|
+
## GitHub Mirror
|
|
51
|
+
|
|
52
|
+
GitHub Mirror is one-way publication from local Markdown Issues to GitHub Issues. Configure `github.repo`, run `gh auth login`, then use `mikan github mirror`, `mikan github push`, the TUI `g` action, or MCP Mirror tools. The full manual is at <https://takemo101.github.io/mikan/github-mirror>.
|
|
53
|
+
|
|
49
54
|
## Agent setup
|
|
50
55
|
|
|
51
56
|
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
57
|
|
|
53
58
|
- `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.
|
|
59
|
+
- `mikan skills add --agent <agent>` installs a small mikan `SKILL.md` that teaches the agent to drive the board through the MCP tools, including one-way GitHub Mirror publication tools. Agents: `claude-code`, `opencode`, `codex`. This is **separate** from MCP registration — installing skills never changes MCP config.
|
|
55
60
|
|
|
56
61
|
```sh
|
|
57
62
|
mikan mcp add --agent claude-code
|