You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: ENVREADME.md
+22-22Lines changed: 22 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,14 +2,14 @@
2
2
3
3
## Setupr AI Provider Keys
4
4
5
-
Setupr provider API keys should be stored globally with `setup auth`, not in a project `.env` file:
5
+
Setupr provider API keys should be stored globally with `setupr auth`, not in a project `.env` file:
6
6
7
7
```bash
8
-
setup auth login
9
-
setup auth set-key github
10
-
setup auth list
11
-
setup auth test
12
-
setup auth use openai/gpt-4.1-mini
8
+
setupr auth login
9
+
setupr auth set-key github
10
+
setupr auth list
11
+
setupr auth test
12
+
setupr auth use openai/gpt-4.1-mini
13
13
```
14
14
15
15
Keys are stored at `~/.setupr/secrets.json` with file permissions `0600`, and Setupr only displays masked values.
@@ -33,15 +33,15 @@ For GitHub Models, use a token that can read GitHub Models. Fine-grained PATs or
33
33
Setupr resolves provider keys in this order:
34
34
35
35
1. Shell environment variables
36
-
2. Global auth storage from `setup auth set-key`
36
+
2. Global auth storage from `setupr auth set-key`
37
37
3. Local `.env.local`
38
38
4. Local `.env`
39
-
5. Saved model preference from `setup auth use` (for model selection only)
39
+
5. Saved model preference from `setupr auth use` (for model selection only)
40
40
41
41
To migrate old provider keys out of a project `.env`:
42
42
43
43
```bash
44
-
setup auth migrate
44
+
setupr auth migrate
45
45
```
46
46
47
47
Project `.env`, `.env.local`, and `.env.example` should primarily describe the app being set up, such as `DATABASE_URL`, `PORT`, or `NEXT_PUBLIC_API_URL`.
@@ -55,7 +55,7 @@ Project `.env`, `.env.local`, and `.env.example` should primarily describe the a
55
55
56
56
If several provider keys are set, the selected model is deterministic:
57
57
58
-
1.`P_SETUP_AI_MODEL` or `setup auth use ...` wins.
58
+
1.`P_SETUP_AI_MODEL` or `setupr auth use ...` wins.
59
59
2. Otherwise Setupr picks the cheapest configured model from its known local pricing table.
60
60
3. GitHub Models catalog pricing is treated as unknown, so GitHub is picked automatically only if explicitly selected or if it is the only configured provider.
61
61
4. The setup pre-warning and TUI timeline show which model the AI director is using.
Copy file name to clipboardExpand all lines: README.md
+30-30Lines changed: 30 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -143,41 +143,41 @@ GitHub Models tokens need GitHub Models access; fine-grained PATs or app tokens
143
143
144
144
```bash
145
145
# Guided setup for provider API keys
146
-
setup auth login
146
+
setupr auth login
147
147
148
148
# Save one provider API key globally
149
-
setup auth set-key github
149
+
setupr auth set-key github
150
150
151
151
# View configured providers without printing raw keys
152
-
setup auth list
152
+
setupr auth list
153
153
154
154
# Test configured providers with tiny requests
155
-
setup auth test
155
+
setupr auth test
156
156
157
157
# View available models
158
-
setup auth models
158
+
setupr auth models
159
159
160
160
# Set preferred model
161
-
setup auth use openai/gpt-4.1-mini
161
+
setupr auth use openai/gpt-4.1-mini
162
162
```
163
163
164
-
Setupr stores provider API keys globally in `~/.setupr/secrets.json` with file permissions `0600`. Raw keys are never printed; `setup auth list` and `setup auth status` show only masked keys.
164
+
Setupr stores provider API keys globally in `~/.setupr/secrets.json` with file permissions `0600`. Raw keys are never printed; `setupr auth list` and `setupr auth status` show only masked keys.
165
165
166
-
`setup auth test` runs configured providers concurrently with short per-provider timeouts. A slow or unavailable provider reports a classified timeout/error without blocking checks for the other configured providers.
166
+
`setupr auth test` runs configured providers concurrently with short per-provider timeouts. A slow or unavailable provider reports a classified timeout/error without blocking checks for the other configured providers.
167
167
168
168
Setupr resolves provider keys in this order:
169
169
170
170
1. Shell environment variables, useful for CI or temporary overrides
171
-
2. Global Setupr auth storage from `setup auth set-key`
171
+
2. Global Setupr auth storage from `setupr auth set-key`
172
172
3. Project `.env.local` / `.env` for backward compatibility only
173
173
174
174
The project `.env` file is for the app being set up, not for Setupr's own API keys. To migrate old project-local provider keys into global auth:
175
175
176
176
```bash
177
-
setup auth migrate
177
+
setupr auth migrate
178
178
```
179
179
180
-
When multiple provider keys are present, `P_SETUP_AI_MODEL` or `setup auth use <model>` wins. If no model is pinned, Setupr chooses the cheapest configured model from its known local pricing table and shows that choice in the pre-execution warning. GitHub Models catalog/custom pricing is treated as unknown, so GitHub is used automatically only when it is explicitly selected or it is the only configured provider.
180
+
When multiple provider keys are present, `P_SETUP_AI_MODEL` or `setupr auth use <model>` wins. If no model is pinned, Setupr chooses the cheapest configured model from its known local pricing table and shows that choice in the pre-execution warning. GitHub Models catalog/custom pricing is treated as unknown, so GitHub is used automatically only when it is explicitly selected or it is the only configured provider.
181
181
182
182
Setupr still accepts `export KEY=value` syntax in project env files for project variables and backward-compatible provider overrides.
183
183
@@ -241,8 +241,8 @@ Every command uses the same error format in plain mode and TUI mode:
241
241
242
242
Examples:
243
243
244
-
-`setup env init` stops if `.env.example` is missing, because Setupr cannot infer required variables. `setup env init --force` creates an empty `.env` and explains that no variables were inferred.
245
-
-`setup auth list` stops on a corrupt `~/.setupr/secrets.json` instead of pretending keys are missing, so existing secrets are not accidentally overwritten.
244
+
-`setupr env init` stops if `.env.example` is missing, because Setupr cannot infer required variables. `setupr env init --force` creates an empty `.env` and explains that no variables were inferred.
245
+
-`setupr auth list` stops on a corrupt `~/.setupr/secrets.json` instead of pretending keys are missing, so existing secrets are not accidentally overwritten.
246
246
- command failures are classified as install, build, test, network, permission, timeout, or missing-tool errors when possible.
247
247
-`--force` skips ordinary prompts, but it does not ignore failed commands, invalid auth storage, missing secrets, or destructive blockers.
248
248
@@ -313,26 +313,26 @@ All command-like actions from setup, doctor, start, plugins, and AI steering pas
313
313
314
314
```bash
315
315
# Open the interactive .env editor TUI
316
-
setup env
316
+
setupr env
317
317
318
318
# Create .env from .env.example
319
-
setup env init
319
+
setupr env init
320
320
321
321
# Overwrite an existing .env from .env.example, or create an empty .env
322
322
# when no .env.example exists
323
-
setup env init --force
323
+
setupr env init --force
324
324
325
325
# Check for missing variables
326
-
setup env check
326
+
setupr env check
327
327
328
328
# Sync structure with .env.example
329
-
setup env sync
329
+
setupr env sync
330
330
331
331
# Smart reorganize + auto-fill
332
-
setup env smart
332
+
setupr env smart
333
333
```
334
334
335
-
Bare `setup env` opens the env editor. If `.env` exists, it opens directly. If only `.env.example` exists, Setupr asks before creating `.env` from the template. If neither file exists, it stops with `ENV_TEMPLATE_MISSING`; `setup env --force` creates an empty `.env` and explains that no variables were inferred.
335
+
Bare `setupr env` opens the env editor. If `.env` exists, it opens directly. If only `.env.example` exists, Setupr asks before creating `.env` from the template. If neither file exists, it stops with `ENV_TEMPLATE_MISSING`; `setupr env --force` creates an empty `.env` and explains that no variables were inferred.
336
336
337
337
### Checkpoint & Resume
338
338
@@ -346,11 +346,11 @@ Bare `setup env` opens the env editor. If `.env` exists, it opens directly. If o
346
346
### Project Memory
347
347
348
348
```bash
349
-
setup notes add "Use pnpm for installs"
350
-
setup notes list
351
-
setuphistory 10
352
-
setup context export team-context.json
353
-
setup context import team-context.json
349
+
setupr notes add "Use pnpm for installs"
350
+
setupr notes list
351
+
setuprhistory 10
352
+
setupr context export team-context.json
353
+
setupr context import team-context.json
354
354
```
355
355
356
356
Notes are saved in `.setupr/notes.json`. History uses `.setupr/history.jsonl`, and context export/import moves a deterministic bundle of notes plus history for team handoff.
@@ -428,15 +428,15 @@ Global config stored at `~/.setupr/config.json`:
428
428
}
429
429
```
430
430
431
-
Provider API keys are stored separately at `~/.setupr/secrets.json` and should be managed with `setup auth`.
431
+
Provider API keys are stored separately at `~/.setupr/secrets.json` and should be managed with `setupr auth`.
432
432
433
433
### Help
434
434
435
435
```bash
436
-
setuphelp
437
-
setuphelp auth
438
-
setup auth --help
439
-
setuphelp auth set-key
436
+
setuprhelp
437
+
setuprhelp auth
438
+
setupr auth --help
439
+
setuprhelp auth set-key
440
440
```
441
441
442
442
Global help lists every command. Command help shows subcommands, variations, options, and examples for that command.
Copy file name to clipboardExpand all lines: SETUP.md
+17-17Lines changed: 17 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,20 +26,20 @@ After installation, the `setup` command is available globally:
26
26
27
27
```bash
28
28
setup
29
-
setup doctor
30
-
setup info
29
+
setupr doctor
30
+
setupr info
31
31
```
32
32
33
33
### Command Discovery
34
34
35
35
Use the built-in help tree when you are not sure which workflow to run:
36
36
37
37
```bash
38
-
setuphelp
39
-
setuphelp chat
40
-
setuphelp git
41
-
setuphelp docker
42
-
setup workspace --help
38
+
setuprhelp
39
+
setuprhelp chat
40
+
setuprhelp git
41
+
setuprhelp docker
42
+
setupr workspace --help
43
43
```
44
44
45
45
The rich help output lists the primary project-control surface, including setup, chat, auth, env, git, CI, Docker, secrets, templates, workspace, health, test, security, fix, release, perf, GitHub, registry, share, plugin, lint, and format commands. Advanced inspection/file-generation commands remain directly runnable for compatibility, but they are not advertised in the primary command index.
@@ -76,21 +76,21 @@ You can steer the agent from the persistent input at the bottom of the TUI. For
76
76
To enable AI-powered features, save at least one provider key in global Setupr auth storage:
77
77
78
78
```bash
79
-
setup auth login
80
-
# Or: setup auth set-key github
79
+
setupr auth login
80
+
# Or: setupr auth set-key github
81
81
```
82
82
83
83
Project `.env` files are for the app being set up, not Setupr's own API keys. For model preference:
84
84
85
85
```bash
86
-
setup auth use kimi-k2-turbo-preview
86
+
setupr auth use kimi-k2-turbo-preview
87
87
# Or temporarily: P_SETUP_AI_MODEL=openai/gpt-4.1 setup
88
88
```
89
89
90
90
Supported model IDs are listed with:
91
91
92
92
```bash
93
-
setup auth models
93
+
setupr auth models
94
94
```
95
95
96
96
Without an API key, Setupr works fully — it just uses pattern matching and heuristics instead of AI for step planning and chat responses.
@@ -162,7 +162,7 @@ setupr perf scan --json
162
162
For non-interactive environments:
163
163
164
164
```bash
165
-
setup --force --plain
165
+
setupr --force --plain
166
166
```
167
167
168
168
This skips safe prompts and outputs plain text (no TUI). Setupr still avoids inventing secrets and should stop for destructive or blocked actions.
@@ -173,15 +173,15 @@ If any setup step fails in plain mode, Setupr stops immediately and returns a no
173
173
174
174
```bash
175
175
# Remove dependency/cache artifacts
176
-
setup clean --deps
176
+
setupr clean --deps
177
177
178
178
# Remove local-only files before sharing a project
179
-
setup clean --share
179
+
setupr clean --share
180
180
181
181
# Remove dependencies, build output, caches, and local env files
182
-
setup clean --all
182
+
setupr clean --all
183
183
```
184
184
185
-
The positional forms also work: `setup clean deps`, `setup clean share`, and `setup clean all`.
185
+
The positional forms also work: `setupr clean deps`, `setupr clean share`, and `setupr clean all`.
186
186
187
-
In TUI mode, `setup clean` opens a safety review before deleting anything. Review the target list, protected-file notes, and risk summary, then type `CLEAN` to confirm. `--force` skips the review prompt and starts cleaning after the target scan, while still reporting exactly what was removed or failed.
187
+
In TUI mode, `setupr clean` opens a safety review before deleting anything. Review the target list, protected-file notes, and risk summary, then type `CLEAN` to confirm. `--force` skips the review prompt and starts cleaning after the target scan, while still reporting exactly what was removed or failed.
0 commit comments