@gaberrb/polypus 0.3.0 → 0.4.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 +23 -0
- package/dist/index.js +403 -48
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -95,11 +95,34 @@ The setup wizard uses the same data: choosing OpenRouter opens an interactive
|
|
|
95
95
|
browser with search, filters (tools-only, free-only) and sorting, then a picker
|
|
96
96
|
showing each model's price, tool badge and context.
|
|
97
97
|
|
|
98
|
+
## Project memory (`.poly/`)
|
|
99
|
+
|
|
100
|
+
`.poly/` is a small, local workspace that teaches the agent how to work in your
|
|
101
|
+
repository. Scaffold it with:
|
|
102
|
+
|
|
103
|
+
```bash
|
|
104
|
+
polypus init # creates .poly/ if missing; --force overwrites
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
It writes a didactic starter set:
|
|
108
|
+
|
|
109
|
+
- `agents.md` — role, golden rules and an index of skills. **Polypus loads this
|
|
110
|
+
file automatically** into the agent's system prompt on every run, so the agent
|
|
111
|
+
follows your conventions instead of guessing.
|
|
112
|
+
- `skills/` — focused how-to guides the agent reads when relevant.
|
|
113
|
+
- `templates/spec.md` — a lean Spec-Driven Development (SDD) template.
|
|
114
|
+
- `README.md` — explains the workspace and how to extend it.
|
|
115
|
+
|
|
116
|
+
Edit `agents.md` to encode your conventions and reference new skills from it.
|
|
117
|
+
Gitignore `.poly/` to keep it personal, or commit it to standardize the workflow
|
|
118
|
+
across your team.
|
|
119
|
+
|
|
98
120
|
## Commands
|
|
99
121
|
|
|
100
122
|
| Command | Description |
|
|
101
123
|
| --- | --- |
|
|
102
124
|
| `polypus setup` | Interactive wizard (agents, keys, permissions). |
|
|
125
|
+
| `polypus init [--force]` | Scaffold a `.poly/` workspace (agents.md, skills, SDD spec template, README). |
|
|
103
126
|
| `polypus add-agent <name> --provider <p> --model <m> [--api-key ...] [--base-url ...] [--tool-mode auto\|native\|emulated] [--set-default]` | Register an agent. |
|
|
104
127
|
| `polypus remove-agent <name>` | Remove an agent. |
|
|
105
128
|
| `polypus list-agents` | List configured agents. |
|