@uge/payo 0.2.0 → 0.3.1
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 +32 -2
- package/dist/index.js +120 -117
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
<img src="https://raw.githubusercontent.com/uttam-gelot/payo/main/assets/logo.png" alt="Payo" width="200" />
|
|
4
4
|
|
|
5
|
-
**Generate project-tailored AI assistant rules & skills in
|
|
5
|
+
**Generate project-tailored AI assistant rules & skills in minutes.**
|
|
6
6
|
|
|
7
7
|
Payo interviews you about your stack, then writes the guidance files your AI
|
|
8
8
|
coding assistant reads — so Claude, Cursor, Copilot, and friends follow _your_
|
|
@@ -33,6 +33,7 @@ project's conventions instead of guessing.
|
|
|
33
33
|
- [AI vs. template generation](#ai-vs-template-generation)
|
|
34
34
|
- [Bootstrap prompt](#bootstrap-prompt)
|
|
35
35
|
- [Resume anytime](#resume-anytime)
|
|
36
|
+
- [Roadmap](#roadmap)
|
|
36
37
|
- [Requirements](#requirements)
|
|
37
38
|
- [Run locally](#run-locally)
|
|
38
39
|
- [Contributing](#contributing)
|
|
@@ -62,7 +63,7 @@ The fix is the guidance files each tool already reads (`CLAUDE.md`,
|
|
|
62
63
|
by hand is tedious, easy to get wrong, and different for every tool. Most people
|
|
63
64
|
never do it, or do it once and let it rot.
|
|
64
65
|
|
|
65
|
-
Payo writes them for you in
|
|
66
|
+
Payo writes them for you in minutes — tailored to your actual stack,
|
|
66
67
|
in each tool's native format — so your assistant follows _your_ conventions from
|
|
67
68
|
the first prompt instead of guessing.
|
|
68
69
|
|
|
@@ -183,6 +184,14 @@ A few environment variables tune AI generation:
|
|
|
183
184
|
| `PAYO_RETRIES` | `1` | Extra attempts after a failed run |
|
|
184
185
|
| `PAYO_AGENT_TIMEOUT_MS` | `120000` | Wall-clock cap per file (ms) |
|
|
185
186
|
|
|
187
|
+
### Your data stays yours
|
|
188
|
+
|
|
189
|
+
Payo has no backend and no telemetry. Rich generation runs entirely through the
|
|
190
|
+
AI CLI **you** already have installed (`claude`, `cursor-agent`, etc.), so your
|
|
191
|
+
answers go only to that tool under your own account and credentials — exactly as
|
|
192
|
+
if you'd prompted it yourself. Payo itself sends nothing to any server; without a
|
|
193
|
+
CLI present it never leaves your machine at all, falling back to local templates.
|
|
194
|
+
|
|
186
195
|
## Bootstrap prompt
|
|
187
196
|
|
|
188
197
|
An empty repo with great guidance is still an empty repo. After generating, Payo
|
|
@@ -197,6 +206,27 @@ Interrupt a run and pick up where you left off. Payo saves your questionnaire
|
|
|
197
206
|
answers and generation progress under `.payo/`; rerun and it resumes, only
|
|
198
207
|
generating what's missing. Finished runs clean the directory up automatically.
|
|
199
208
|
|
|
209
|
+
## Roadmap
|
|
210
|
+
|
|
211
|
+
Payo works today, but it's still early. Here's where it's headed:
|
|
212
|
+
|
|
213
|
+
- **First-class existing-project support.** Right now Payo shines on a fresh
|
|
214
|
+
repo. The next big step is making it just as good on an established codebase:
|
|
215
|
+
**detect** the stack from what's already there (manifests, lockfiles, config,
|
|
216
|
+
folder layout), **auto-answer** the questionnaire from that evidence, and let
|
|
217
|
+
you confirm or tweak instead of typing it all out — then the normal generation
|
|
218
|
+
flow continues.
|
|
219
|
+
- **Broader stack coverage.** More languages, frameworks, ORMs, databases, and
|
|
220
|
+
AI tools, plus deeper, more opinionated defaults for the ones already
|
|
221
|
+
supported — so the guidance fits more of the ecosystem out of the box.
|
|
222
|
+
- **A smoother flow.** Faster, clearer prompts; better defaults and grouping;
|
|
223
|
+
tighter summaries and confirmations; and a generation step that's quicker and
|
|
224
|
+
more transparent about what it's doing.
|
|
225
|
+
|
|
226
|
+
Have a stack you want supported or an idea to make the flow better?
|
|
227
|
+
[Open an issue](https://github.com/uttam-gelot/payo/issues) or see
|
|
228
|
+
[Contributing](#contributing).
|
|
229
|
+
|
|
200
230
|
## Requirements
|
|
201
231
|
|
|
202
232
|
**To run Payo:** [Node.js](https://nodejs.org) **>= 18**. That's it — `npx @uge/payo`
|