Skip to content

Commit 52d7c1a

Browse files
committed
docs: clarify FCM-Pi extension is BETA, install via local path only
1 parent 01c9567 commit 52d7c1a

2 files changed

Lines changed: 24 additions & 15 deletions

File tree

README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -466,28 +466,27 @@ When a tool mode is active (via `Z`), models incompatible with that tool are hig
466466

467467
---
468468

469-
## π Pi Extension — FCM-Pi
469+
## π Pi Extension — FCM-Pi ⚠️ BETA
470470

471471
**FCM-Pi** is a native [Pi coding agent](https://pi.dev) extension that integrates `free-coding-models` directly into your Pi session. It auto-selects the best free model on startup, shows a live animated scan in the Pi status bar, and lets you hot-swap models mid-session.
472472

473+
> **BETA** — The extension is under active development and not yet published to npm. Install via local path only.
474+
>
473475
> **Requires**: Pi coding agent (pi.dev) + free-coding-models installed and configured with at least one API key.
474476
475477
### Installation
476478

477-
Add the extension to your Pi settings (`~/.pi/agent/settings.json`):
479+
Add the extension path to `~/.pi/agent/settings.json` (the extension is **not yet on npm** — local path only for now):
478480

479481
```json
480482
{
481483
"packages": [
482-
"../../Documents/GitHub/free-coding-models/pi-extension"
484+
"/Users/yourname/Documents/GitHub/free-coding-models/pi-extension"
483485
]
484486
}
485487
```
486488

487-
Or install directly from the Pi shell once published to npm:
488-
```bash
489-
pi install npm:fcm-pi
490-
```
489+
Then restart Pi. The extension loads automatically.
491490

492491
### What it does
493492

pi-extension/README.md

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# FCM-Pi — Pi Extension for free-coding-models
22

3+
> ⚠️ **BETA** — This extension is under active development. Install via local path only (see below). It is not yet published to npm.
4+
35
A native JavaScript extension for the **[Pi coding agent](https://pi.dev)** that wires **free-coding-models** directly into your Pi session. It pings ~30 candidate models in parallel, benchmarks the top 5, auto-selects the best one on startup, and displays a real-time animated progress scan in the Pi status bar.
46

57
---
@@ -33,26 +35,34 @@ A native JavaScript extension for the **[Pi coding agent](https://pi.dev)** that
3335

3436
2. **Pi coding agent (pi.dev)** must be installed on your system.
3537

36-
### Installation (local path)
38+
### Installation
39+
40+
The extension is **not yet published to npm** — install directly via local path.
3741

38-
Add the extension to `~/.pi/agent/settings.json`:
42+
Add the extension path to `~/.pi/agent/settings.json`:
3943

4044
```json
4145
{
4246
"packages": [
43-
"../../Documents/GitHub/free-coding-models/pi-extension"
47+
"/absolute/path/to/free-coding-models/pi-extension"
4448
]
4549
}
4650
```
4751

48-
Adjust the path to match where you cloned `free-coding-models` on your machine.
49-
50-
### Installation (npm — when published)
52+
Example on macOS:
5153

52-
```bash
53-
pi install npm:fcm-pi
54+
```json
55+
{
56+
"packages": [
57+
"/Users/yourname/Documents/GitHub/free-coding-models/pi-extension"
58+
]
59+
}
5460
```
5561

62+
> 💡 You can also use a relative path from `~/.pi/agent/` — e.g. `"../../Documents/GitHub/free-coding-models/pi-extension"`
63+
64+
After editing `settings.json`, restart Pi. The extension loads automatically — no extra command needed.
65+
5666
---
5767

5868
## 📊 Scan Progress Display

0 commit comments

Comments
 (0)