coding-friend-cli 1.35.6 → 1.35.7
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 +17 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,6 +2,23 @@
|
|
|
2
2
|
|
|
3
3
|
CLI companion for the [coding-friend](https://github.com/dinhanhthi/coding-friend) plugin — a lean toolkit for disciplined engineering workflows with Claude Code.
|
|
4
4
|
|
|
5
|
+
## Plugin without the CLI?
|
|
6
|
+
|
|
7
|
+
If you installed the Coding Friend plugin through the Claude Code marketplace but cannot install or run this CLI (npm errors, sandboxed environment, restricted machine), **the plugin still works**. You lose:
|
|
8
|
+
|
|
9
|
+
- Fast indexed memory search — falls back to `grep -r '<query>' docs/memory/`
|
|
10
|
+
- The `coding-friend-learn-host` doc viewer — open `docs/learn/*.md` directly in your editor
|
|
11
|
+
- The `cf statusline` renderer — Claude Code's default statusline takes over
|
|
12
|
+
|
|
13
|
+
Everything else (every skill, every agent, every hook except the three OPTIONAL hooks above) is unaffected. See [`../docs/cli-requirements.md`](../docs/cli-requirements.md) for the full matrix.
|
|
14
|
+
|
|
15
|
+
### Common CLI install issues
|
|
16
|
+
|
|
17
|
+
- **`node` not found** — install Node.js 20+ from <https://nodejs.org> (the CLI declares `engines.node >= 20`; older versions will refuse to install).
|
|
18
|
+
- **`EACCES` on global install** — set a user-writable global prefix: `npm config set prefix ~/.npm-global` and add `~/.npm-global/bin` to your `PATH`.
|
|
19
|
+
- **`cf` not on PATH after install** — verify with `npm root -g` and ensure that directory's `bin/` is in your `PATH`.
|
|
20
|
+
- **MCP server not appearing in Claude Code** — after install, run `cf mcp` to register the memory MCP, then restart Claude Code.
|
|
21
|
+
|
|
5
22
|
## Requirements
|
|
6
23
|
|
|
7
24
|
- Node.js >= 20
|