Skip to content

Commit a15d76c

Browse files
Jktfeclaude
andcommitted
fix: Correct installation instructions in README
Replace non-existent `claude plugin add` commands with actual working methods: plugin install from GitHub and --plugin-dir for local use. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent ab7d09d commit a15d76c

1 file changed

Lines changed: 16 additions & 4 deletions

File tree

README.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,14 +45,26 @@ Optionally include the main spec for full type and constraint information:
4545

4646
## Installation
4747

48+
### From GitHub (recommended)
49+
50+
```bash
51+
claude plugin install flowspec@https://github.com/Jktfe/flowspec-claude-code-plugin
52+
```
53+
54+
### Local install
55+
56+
Clone the repo and load it with `--plugin-dir`:
57+
4858
```bash
49-
claude plugin add flowspec
59+
git clone https://github.com/Jktfe/flowspec-claude-code-plugin.git
60+
claude --plugin-dir ./flowspec-claude-code-plugin
5061
```
5162

52-
Or install locally from a cloned repo:
63+
This loads the plugin for that session. To always load it, add the flag to your shell alias:
5364

5465
```bash
55-
claude plugin add --local ./flowspec-claude-code-plugin
66+
# In your .zshrc or .bashrc
67+
alias claude='claude --plugin-dir /path/to/flowspec-claude-code-plugin'
5668
```
5769

5870
## How It Works
@@ -66,7 +78,7 @@ Both skills are pure knowledge — they teach Claude how to read and use FlowSpe
6678

6779
1. Design your data architecture in [FlowSpec](https://flowspec.dev)
6880
2. Export the main YAML and any wireframe sub-canvases
69-
3. Start a Claude Code session in your project
81+
3. Start a Claude Code session with the plugin loaded (see Installation above)
7082
4. Load the spec: `/flowspec:spec ./flowspec-export.yaml`
7183
5. Ask Claude to build features: "Generate TypeScript types for the user profile section"
7284
6. For specific UI sections: `/flowspec:wireframe ./profile-header.png ./profile-header.yaml`

0 commit comments

Comments
 (0)