Skip to content

Commit 05516dc

Browse files
committed
Update README.md to:
- reflect build directory change (build -> dist), - expand on how to use different Node package runners to install plain-forge-
1 parent f985b5a commit 05516dc

1 file changed

Lines changed: 31 additions & 3 deletions

File tree

‎README.md‎

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ macOS and Linux:
2222

2323
```bash
2424
curl -fsSL https://codeplain.ai/install.sh | bash
25+
# re-run to update to the latest version
2526
```
2627

2728
Windows PowerShell:
@@ -44,12 +45,39 @@ export CODEPLAIN_API_KEY="your_actual_api_key_here"
4445

4546
You describe what you want in plain English, an agent helps you write a spec in \*\*\*plain language, and \*codeplain renders the actual code. This is what [plain-forge](https://github.com/Codeplain-ai/plain-forge) sets up: a toolkit of skills, rules, and docs that plugs into your AI coding agent of choice — Claude Code, Codex, ForgeCode, OpenCode, or any other agent that reads from a standard skills directory — and turns a conversation into a complete `.plain` spec, then keeps maintaining it across the lifetime of the project.
4647

47-
If you didn't install it during step 1, run it any time:
48+
If you didn't install it during step 1, run it any time using your favorite Node package runner:
4849

4950
```bash
5051
npx plain-forge install
5152
```
5253

54+
The same command works with any other runner — pick whichever matches your toolchain:
55+
56+
```bash
57+
# npm (bundled with Node.js)
58+
npx plain-forge install
59+
60+
# pnpm
61+
pnpm dlx plain-forge install
62+
63+
# Bun
64+
bunx plain-forge install
65+
66+
# Yarn (Berry, v2+)
67+
yarn dlx plain-forge install
68+
69+
# Deno (npm: specifier, needs permissions to write the skills directory)
70+
deno run -A npm:plain-forge install
71+
```
72+
73+
Every runner downloads `plain-forge` on demand and runs it without adding it to your project's dependencies. The package exposes a `plain-forge` binary, so no runner needs an extra `--package` flag.
74+
75+
`install` fails if plain-forge is already installed at the target — to refresh an existing installation to the latest skills, rules, and docs, use `update` instead (swap in your runner of choice):
76+
77+
```bash
78+
npx plain-forge update
79+
```
80+
5381
### 3. Convert specs into tested and validated code
5482

5583
\*codeplain extends coding agents with agentic skills for working at the specification layer, and with tools that convert specifications into tested and validated implementation code.
@@ -71,9 +99,9 @@ You can immediately test the system with a simple "Hello World" example:
7199

72100
_Note: Rendering will take a few minutes to complete._
73101

74-
- The system will generate a Python application in the `build` directory. You can run it with:
102+
- The system will generate a Python application in the `dist` directory. You can run it with:
75103
```bash
76-
cd build
104+
cd dist
77105
python hello_world.py
78106
```
79107

0 commit comments

Comments
 (0)