@amrishkhan05/frankly 0.1.2 → 1.0.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 +40 -24
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -60,6 +60,17 @@ npm test
|
|
|
60
60
|
# Build the project
|
|
61
61
|
npm run build
|
|
62
62
|
```
|
|
63
|
+
|
|
64
|
+
**Commands Overview**
|
|
65
|
+
|
|
66
|
+
| Command | Description |
|
|
67
|
+
|---|---|
|
|
68
|
+
| `git clone https://github.com/amrishkhan05/frankly.git` | Clone the repository |
|
|
69
|
+
| `npm install` | Install dependencies |
|
|
70
|
+
| `npm test` | Run the test suite |
|
|
71
|
+
| `npm run build` | Build the project |
|
|
72
|
+
| `npm install @amrishkhan05/frankly` | Install the package from npm |
|
|
73
|
+
|
|
63
74
|
|
|
64
75
|
> **Note:** The package is now published on npm. Install with `npm install @amrishkhan05/frankly`.
|
|
65
76
|
|
|
@@ -89,37 +100,45 @@ The repository has not claimed an npm release yet, so this README does not prete
|
|
|
89
100
|
|
|
90
101
|
## Claude Code plugin
|
|
91
102
|
|
|
92
|
-
Frankly's public GitHub repository is also its Claude Code marketplace.
|
|
103
|
+
Frankly's public GitHub repository is also its Claude Code marketplace. Use the following commands:
|
|
104
|
+
|
|
105
|
+
| Command | Description |
|
|
106
|
+
|---|---|
|
|
107
|
+
| `claude plugin marketplace add amrishkhan05/frankly` | Add Frankly to the Claude marketplace |
|
|
108
|
+
| `claude plugin install frankly@frankly` | Install the Frankly plugin |
|
|
93
109
|
|
|
94
|
-
```bash
|
|
95
|
-
claude plugin marketplace add amrishkhan05/frankly
|
|
96
|
-
claude plugin install frankly@frankly
|
|
97
|
-
```
|
|
98
110
|
|
|
99
111
|
The marketplace catalog is [`.claude-plugin/marketplace.json`](.claude-plugin/marketplace.json). It installs the plugin from this repository root (`"source": "./"`), which contains its manifest, MCP configuration, hooks, and skills. The plugin's explicit version is `0.1.0`; users receive future marketplace updates when that version changes.
|
|
100
112
|
|
|
101
113
|
After an update, refresh the marketplace and plugin:
|
|
102
114
|
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
claude plugin update frankly
|
|
106
|
-
|
|
115
|
+
| Command | Description |
|
|
116
|
+
|---|---|
|
|
117
|
+
| `claude plugin marketplace update frankly` | Update marketplace entry |
|
|
118
|
+
| `claude plugin update frankly@frankly` | Update installed plugin |
|
|
119
|
+
|
|
107
120
|
|
|
108
121
|
For local development, validate and install the checkout as a marketplace:
|
|
109
122
|
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
123
|
+
For local development, validate and install the checkout as a marketplace:
|
|
124
|
+
|
|
125
|
+
| Command | Description |
|
|
126
|
+
|---|---|
|
|
127
|
+
| `claude plugin validate .` | Validate plugin locally |
|
|
128
|
+
| `claude plugin marketplace add ./` | Add current directory to marketplace |
|
|
129
|
+
| `claude plugin install frankly@frankly` | Install the plugin |
|
|
130
|
+
|
|
115
131
|
|
|
116
132
|
Run `/reload-plugins` when Claude Code asks for activation after installation or an update. `claude plugin list` shows the installed plugin and version.
|
|
117
133
|
|
|
118
134
|
For a one-session local checkout without marketplace installation:
|
|
119
135
|
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
136
|
+
For a one-session local checkout without marketplace installation:
|
|
137
|
+
|
|
138
|
+
| Command | Description |
|
|
139
|
+
|---|---|
|
|
140
|
+
| `claude --plugin-dir /absolute/path/to/frankly` | Run Claude with the Frankly plugin directory |
|
|
141
|
+
|
|
123
142
|
|
|
124
143
|
The plugin bundles Frankly's MCP server and a `Stop` hook. At task completion it runs a Red Ink Review; when correction is warranted it returns exactly one constrained correction request. The second stop is allowed, preventing loops. Claude Code's current plugin layout and hook behavior are documented in the [official plugin reference](https://code.claude.com/docs/en/plugins-reference) and [hooks reference](https://code.claude.com/docs/en/hooks).
|
|
125
144
|
|
|
@@ -247,13 +266,10 @@ See Kilo's [current MCP documentation](https://kilo.ai/docs/automate/mcp/using-i
|
|
|
247
266
|
|
|
248
267
|
The published `frankly` executable and the source checkout support the same subcommands. Run commands from the repository you want to analyze. The CLI reads its working-tree diff and its `frankly.config.json`.
|
|
249
268
|
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
npm run dev -- <command> [options]
|
|
253
|
-
|
|
254
|
-
# After building, through the package executable
|
|
255
|
-
frankly <command> [options]
|
|
256
|
-
```
|
|
269
|
+
| Use case | Command |
|
|
270
|
+
|---|---|
|
|
271
|
+
| From a source checkout | `npm run dev -- <command> [options]` |
|
|
272
|
+
| After building (package executable) | `frankly <command> [options]` |
|
|
257
273
|
|
|
258
274
|
### CLI command reference
|
|
259
275
|
|