@uge/payo 0.3.4 → 1.0.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.
Files changed (3) hide show
  1. package/README.md +49 -11
  2. package/dist/index.js +166 -158
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -28,6 +28,7 @@ project's conventions instead of guessing.
28
28
  - [Who is this for?](#who-is-this-for)
29
29
  - [Quick Start](#quick-start)
30
30
  - [How to use — a walkthrough](#how-to-use--a-walkthrough)
31
+ - [Already have a project? Payo detects your stack](#already-have-a-project-payo-detects-your-stack)
31
32
  - [What gets generated](#what-gets-generated)
32
33
  - [What it asks about](#what-it-asks-about)
33
34
  - [AI vs. template generation](#ai-vs-template-generation)
@@ -117,24 +118,60 @@ guidance files straight into your repo.
117
118
 
118
119
  1. **Run Payo from your project root.** `npx @uge/payo` — it writes into the
119
120
  current directory, so `cd` into the repo first.
120
- 2. **Answer the questionnaire.** Pick your AI tool, project type, language,
121
+ 2. **Existing repo? It's auto-detected.** If Payo finds a manifest, it reads your
122
+ stack and pre-fills the questionnaire, so most stack questions become a quick
123
+ confirm-and-skip instead of typing. See
124
+ [Already have a project?](#already-have-a-project-payo-detects-your-stack).
125
+ 3. **Answer the questionnaire.** Pick your AI tool, project type, language,
121
126
  framework, and so on. Questions **adapt to your answers** — choose Next.js
122
127
  and you get Next.js-specific follow-ups; choose Postgres and you're asked
123
128
  about migrations and naming. Most prompts ship a **recommended default**, so
124
129
  you can blast through with <kbd>Enter</kbd>.
125
- 3. **Review your stack — and edit inline.** Before writing anything, Payo shows a
130
+ 4. **Review your stack — and edit inline.** Before writing anything, Payo shows a
126
131
  summary of every answer. Choose **Edit an answer** to change any response — or
127
132
  re-open a section you skipped — right from the review; dependent questions are
128
133
  re-asked automatically. Pick **Generate** when it looks right.
129
- 4. **Payo generates the guidance.** It writes each tool's files in their native
134
+ 5. **Payo generates the guidance.** It writes each tool's files in their native
130
135
  format and location (see the table below). With the tool's CLI installed,
131
136
  files are generated in parallel by the AI; otherwise solid templates are used.
132
- 5. **(Optional) Get a bootstrap prompt.** Payo offers to write a paste-ready
137
+ 6. **(Optional) Get a bootstrap prompt.** Payo offers to write a paste-ready
133
138
  `bootstrap-prompt.md` you hand to any LLM to scaffold a runnable project that
134
139
  honors the guidance it just generated.
135
- 6. **Interrupted? Just rerun.** Progress lives under `.payo/`; Payo resumes and
140
+ 7. **Interrupted? Just rerun.** Progress lives under `.payo/`; Payo resumes and
136
141
  only generates what's missing.
137
142
 
143
+ ## Already have a project? Payo detects your stack
144
+
145
+ Payo isn't just for empty repos. Run it in an established project and it **reads
146
+ what's already there** — `package.json`, `pyproject.toml`, `go.mod`, `Cargo.toml`,
147
+ lockfiles, tool configs, and the folder layout — to figure out your stack across
148
+ **TypeScript/JavaScript, Python, Go, and Rust**, then pre-fills the questionnaire
149
+ from that evidence. You confirm or tweak instead of typing it all out.
150
+
151
+ When detection finds a manifest, you get two quick choices:
152
+
153
+ - **Work with the existing project, or start fresh?** Keep the detected answers, or
154
+ ignore them and answer from scratch.
155
+ - **Detect everything, or just the stack?** Fill in stack facts only, or also
156
+ pre-fill the convention questions (folder structure and the like) that Payo can
157
+ infer from your layout.
158
+
159
+ How detected answers are applied:
160
+
161
+ - **Stack facts** (language, framework, database, ORM, package manager, test
162
+ runner, linter…) are filled in and **skipped** — they're things a manifest can
163
+ state authoritatively, so there's nothing to ask.
164
+ - **Conventions and preferences** are surfaced as **pre-filled defaults you still
165
+ confirm** — a manifest can't encode intent, so Payo never silently decides these
166
+ for you.
167
+
168
+ Detection runs deterministically from your files first. When the chosen AI tool's
169
+ CLI is installed, an **optional second pass** uses **your own** assistant to fill
170
+ gaps on unusual stacks — it reads only the manifest and the directory listing,
171
+ runs under your own account, and never sends anything to a Payo server (see
172
+ [Your data stays yours](#your-data-stays-yours)). If no CLI is present, the
173
+ deterministic result stands on its own.
174
+
138
175
  ## What gets generated
139
176
 
140
177
  Each tool gets files in its own native format and location:
@@ -213,12 +250,13 @@ generating what's missing. Finished runs clean the directory up automatically.
213
250
 
214
251
  Payo works today, but it's still early. Here's where it's headed:
215
252
 
216
- - **First-class existing-project support.** Right now Payo shines on a fresh
217
- repo. The next big step is making it just as good on an established codebase:
218
- **detect** the stack from what's already there (manifests, lockfiles, config,
219
- folder layout), **auto-answer** the questionnaire from that evidence, and let
220
- you confirm or tweak instead of typing it all out then the normal generation
221
- flow continues.
253
+ - **Deeper existing-project detection.** Payo already detects an established
254
+ repo's stack and pre-fills the questionnaire (see
255
+ [Already have a project?](#already-have-a-project-payo-detects-your-stack)).
256
+ Next is making that just as sharp on **monorepos**: today detection reads the
257
+ root manifest, so a workspace whose real stack lives in `apps/*` and
258
+ `packages/*` underfills. Workspace-aware, multi-root detection — plus broader
259
+ signal coverage — is the next step.
222
260
  - **Broader stack coverage.** More languages, frameworks, ORMs, databases, and
223
261
  AI tools, plus deeper, more opinionated defaults for the ones already
224
262
  supported — so the guidance fits more of the ecosystem out of the box.