coding-friend-cli 1.0.0 → 1.0.1
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 +81 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
# coding-friend-cli
|
|
2
|
+
|
|
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
|
+
|
|
5
|
+
## Requirements
|
|
6
|
+
|
|
7
|
+
- Node.js >= 18
|
|
8
|
+
- The [coding-friend plugin](https://github.com/dinhanhthi/coding-friend) installed in Claude Code
|
|
9
|
+
|
|
10
|
+
## Install
|
|
11
|
+
|
|
12
|
+
```bash
|
|
13
|
+
npm i -g coding-friend-cli
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## Commands
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
cf init # Initialize workspace (interactive)
|
|
20
|
+
# 💡 You can run this anywhere, anytime.
|
|
21
|
+
cf host [path] # Build and serve learning docs at localhost:3333
|
|
22
|
+
# [path] is optional, default is `docs/learn`
|
|
23
|
+
cf mcp [path] # Setup MCP server for LLM integration
|
|
24
|
+
# [path] is optional, default is `docs/learn`
|
|
25
|
+
# This prints a JSON config snippet to add to your client's MCP
|
|
26
|
+
cf statusline # Setup coding-friend statusline
|
|
27
|
+
cf update # Update plugin + fix statusline
|
|
28
|
+
cf help # Show all commands
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
## 🐳 CLI Development
|
|
32
|
+
|
|
33
|
+
To work on the CLI locally:
|
|
34
|
+
|
|
35
|
+
```bash
|
|
36
|
+
cd cli
|
|
37
|
+
npm install
|
|
38
|
+
npm run build
|
|
39
|
+
npm link # Creates global symlink for `cf` binary
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
Now `cf` is available globally, pointing to your local source. After making changes:
|
|
43
|
+
|
|
44
|
+
```bash
|
|
45
|
+
npm run build # Rebuild (no need to re-link)
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
For development without rebuilding:
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
npm run dev -- <command> # e.g. npm run dev -- init
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
To unlink when done:
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
npm unlink -g coding-friend-cli
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
## Publish CLI to npm
|
|
61
|
+
|
|
62
|
+
```bash
|
|
63
|
+
# From the root of coding-friend project
|
|
64
|
+
cd cli
|
|
65
|
+
npm login # Login if not already
|
|
66
|
+
npm publish # Build + bundle + publish
|
|
67
|
+
|
|
68
|
+
# To bump a version
|
|
69
|
+
npm version patch # 1.0.1 -> 1.0.2
|
|
70
|
+
npm version minor # 1.0.1 -> 1.1.0
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
`prepublishOnly` runs automatically: builds TypeScript → `dist/` and bundles libs from `lib/`.
|
|
74
|
+
|
|
75
|
+
- Bump `version` in `cli/package.json` before publishing
|
|
76
|
+
- First time or public package: `npm publish --access public`
|
|
77
|
+
- Package name: `coding-friend-cli` → users install with `npm i -g coding-friend-cli`
|
|
78
|
+
|
|
79
|
+
## License
|
|
80
|
+
|
|
81
|
+
MIT
|