faberwright 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 +136 -22
- package/dist/agent.js +9 -1
- package/dist/config.js +48 -5
- package/dist/credentials.js +134 -0
- package/dist/index.js +225 -9
- package/dist/llm.js +79 -3
- package/dist/models.js +70 -0
- package/dist/onboard.js +254 -0
- package/dist/pricing.js +254 -0
- package/dist/prompt.js +79 -2
- package/dist/routes.js +143 -0
- package/dist/settings.js +55 -0
- package/dist/sigv4.js +177 -0
- package/dist/usage.js +129 -29
- package/package.json +10 -2
package/README.md
CHANGED
|
@@ -27,17 +27,17 @@ tokens: 31.2k in (78% cached) / 1.9k out · 7 calls
|
|
|
27
27
|
## Your first session (2 minutes)
|
|
28
28
|
|
|
29
29
|
```bash
|
|
30
|
-
cd your-project # any repo
|
|
30
|
+
cd your-project # any repo; Faber works on the folder you're in
|
|
31
31
|
faber # start the REPL (approval mode is on by default)
|
|
32
32
|
```
|
|
33
33
|
|
|
34
|
-
1. **Give it a real task
|
|
35
|
-
2. **Approve the diff**
|
|
36
|
-
3. **See the safety net
|
|
37
|
-
4. **Undo it
|
|
38
|
-
5. **Come back tomorrow
|
|
34
|
+
1. **Give it a real task.** Try `add a comment explaining what the main entry file does`
|
|
35
|
+
2. **Approve the diff** with the arrow keys and Enter. Cursor starts on Yes; "Always this session" grants trust. Shell commands ask too.
|
|
36
|
+
3. **See the safety net.** `/history` lists every task with the files it touched.
|
|
37
|
+
4. **Undo it.** `/undo` reverts the task, and if you change your mind changed your mind? `/redo` brings it back. Nothing is ever lost in either direction.
|
|
38
|
+
5. **Come back tomorrow.** `faber --resume` continues the conversation, or just ask *"what did we do last time?"* — it searches past sessions itself.
|
|
39
39
|
|
|
40
|
-
That loop
|
|
40
|
+
That loop of task, approve, inspect, revert is the whole trust model. Everything else is detail.
|
|
41
41
|
|
|
42
42
|
## Why Faber
|
|
43
43
|
|
|
@@ -49,23 +49,62 @@ That loop — **task, approve, inspect, revert** — is the whole trust model. E
|
|
|
49
49
|
|
|
50
50
|
**It remembers.** Facts, decisions, and gotchas persist per-project in SQLite. Sessions survive crashes (append-only JSONL). New sessions start with a digest of the last one, and the agent searches past conversations when you reference them.
|
|
51
51
|
|
|
52
|
-
**You can steer it mid-flight.** See it going the wrong way? Just type
|
|
52
|
+
**You can steer it mid-flight.** See it going the wrong way? Just type `use TypeScript, not JavaScript` — and your guidance is injected at the next loop iteration. No cancelling, no wasted tokens.
|
|
53
53
|
|
|
54
54
|
## Upgrading from Codewright
|
|
55
55
|
|
|
56
|
-
Faber is Codewright renamed
|
|
56
|
+
Faber is Codewright renamed, after the npm name was taken between building and releasing. Existing projects keep working untouched: an existing `.codewright/` state directory is adopted as-is, so memory, code graph, sessions, and usage history all survive. `CW_*` environment variables still work alongside the canonical `FABER_*` names. New projects get `.faber/`.
|
|
57
57
|
|
|
58
58
|
## Requirements & install
|
|
59
59
|
|
|
60
|
-
Node.js
|
|
60
|
+
You need Node.js 22.5 or newer. Faber uses Node's built-in SQLite, so there are no native dependencies to compile and installs don't fail on a missing toolchain. The only runtime dependencies are two small pure-JS packages.
|
|
61
61
|
|
|
62
62
|
```bash
|
|
63
|
-
npm install -g
|
|
64
|
-
|
|
65
|
-
faber # you're in
|
|
63
|
+
npm install -g faberwright
|
|
64
|
+
faber
|
|
66
65
|
```
|
|
67
66
|
|
|
68
|
-
|
|
67
|
+
The first time you run it, Faber asks three questions and remembers the answers:
|
|
68
|
+
|
|
69
|
+
```
|
|
70
|
+
Welcome to Faber.
|
|
71
|
+
Let's pick where your model comes from. You can change this any time with /route or /model.
|
|
72
|
+
|
|
73
|
+
Who provides the model?
|
|
74
|
+
❯ Anthropic
|
|
75
|
+
OpenAI
|
|
76
|
+
Local
|
|
77
|
+
Other
|
|
78
|
+
|
|
79
|
+
How should Faber reach it?
|
|
80
|
+
❯ Anthropic API direct, pay per token with your own key
|
|
81
|
+
Amazon Bedrock your AWS account owns auth and billing
|
|
82
|
+
Google Vertex AI your GCP project owns auth and billing (not yet wired)
|
|
83
|
+
|
|
84
|
+
Faber needs an API key for Anthropic API.
|
|
85
|
+
Get one at https://console.anthropic.com/settings/keys
|
|
86
|
+
ANTHROPIC_API_KEY (hidden): ••••••••••••
|
|
87
|
+
|
|
88
|
+
Default model
|
|
89
|
+
❯ sonnet balanced, a good default for daily work
|
|
90
|
+
opus most capable, for complex multi-step work
|
|
91
|
+
haiku fastest and cheapest, for simple tasks
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
Nothing is written until setup finishes. Quit halfway through and the next run starts over from the first question, so you can never end up half-configured. Every later launch checks that your setup can actually reach a model before it opens the prompt, which means a missing key gets caught at startup rather than surfacing as a confusing error partway through a task.
|
|
95
|
+
|
|
96
|
+
If a key is already in your environment, Faber says so and asks what to do with it: use it and remember it, use it without saving, or replace it with a different one. A key you deliberately paste wins over the environment variable, because an explicit choice shouldn't be silently overridden.
|
|
97
|
+
|
|
98
|
+
Your key never leaves your machine. Faber has no server and no account of its own, and it talks only to the model provider you pick. Keys you give it are written to `~/.faber/credentials.json` with owner-only permissions, never into your project folder, where a stray `git add` could publish them.
|
|
99
|
+
|
|
100
|
+
Environment variables still work and still take precedence, so existing setups and CI keep running unchanged:
|
|
101
|
+
|
|
102
|
+
```bash
|
|
103
|
+
export ANTHROPIC_API_KEY=sk-ant-...
|
|
104
|
+
faber
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
Setup is skipped entirely when there's no terminal attached, so scripts and CI never block on a prompt. And if you don't have an API key at all, pick **Local → Ollama** during setup and Faber runs against a model on your own machine, no key and no cost.
|
|
69
108
|
|
|
70
109
|
## Features
|
|
71
110
|
|
|
@@ -74,6 +113,8 @@ Any OpenAI-compatible provider: `FABER_PROVIDER=openai`, `OPENAI_API_KEY`, `FABE
|
|
|
74
113
|
| **Streaming agent loop** | Text renders as generated, with a live heartbeat (`✳ Working… 14s`) that never interleaves with output and ends in `✳ Worked for 14s`. Plan → tool → observe → adjust, until done. Hard iteration cap. |
|
|
75
114
|
| **Code graph** | Symbols *and* call/import edges, incrementally maintained (only changed files re-parse). Agent tools: `who_calls` (blast radius), `calls_from` (dependencies), `trace_path` (workflow chain). A compact repo map of the most-connected symbols orients every task. Edges are static hints — dynamic dispatch/DI/events aren't captured; the agent reads code where precision matters. |
|
|
76
115
|
| **Approval by default** | Arrow-key menu on every file edit (colored diff) and every shell command. `--auto` / `/auto` / `FABER_APPROVAL=auto` opts into autonomy. |
|
|
116
|
+
| **Guided setup** | First run walks through vendor, route, credential and model, then remembers it. Later launches verify the setup can reach a model before opening the prompt. Nothing is saved until setup finishes, so an interrupted run leaves no half-configured state. |
|
|
117
|
+
| **Credentials** | Keys live in `~/.faber/credentials.json`, owner-only, outside every repository. Faber checks that what you paste looks like a key before storing it, hides it as you type, and never prints more than a masked fragment. Environment variables keep working and take precedence. |
|
|
77
118
|
| **Interactive choices** | Genuinely ambiguous request? The agent presents 2–4 options plus "Chat more about this instead" before writing code. |
|
|
78
119
|
| **Mid-task steering** | Type while it works; guidance is injected at the next loop boundary. If the model finishes while steering is queued, the task continues instead. Steering markers carry a per-task nonce, so hostile file contents can't impersonate you. |
|
|
79
120
|
| **Paste as chips** | Raw-mode composer: pasting a 50-line block renders only a chip — `[pasted #1 +50 lines]` — never the code itself, while the full text is expanded into the message on Enter. Paste the same block again to expand it visibly. Paste, type, paste again: one submission. Full line editing: arrows, Home/End, forward-delete, Ctrl-A/E/K/U, Up/Down history; long drafts wrap across rows with exact cursor tracking — backspace and arrows travel across wrap boundaries. Chips are atomic — one arrow step, one backspace. Works at the prompt and while steering. |
|
|
@@ -84,13 +125,81 @@ Any OpenAI-compatible provider: `FABER_PROVIDER=openai`, `OPENAI_API_KEY`, `FABE
|
|
|
84
125
|
| **Prompt caching** | Cache breakpoints on system prompt, tools, and sliding conversation history. Typical tasks: 60–90% of input from cache. |
|
|
85
126
|
| **Output discipline** | Research-informed brevity (Chain-of-Draft style): short prose answers, shorthand inter-tool notes, no postamble — with an explicit exception that code correctness and completeness are never sacrificed for token count. `/verbose` toggles full-depth explanations. `FABER_WEAK_MODEL` routes internal summarization (compaction, digests) to a cheap model. |
|
|
86
127
|
| **Token transparency** | Per-task footer with cache rate. Set `FABER_PRICE_IN` / `FABER_PRICE_OUT` ($/Mtok) for cost estimates. |
|
|
87
|
-
| **Usage dashboard** | `/usage` shows a persistent ledger: tasks, tokens, cache rate, cost, and cache *savings* — for this session, today, and all time, plus totals across every project on the machine. Records live in `.faber/usage.db` per project and survive restarts. |
|
|
128
|
+
| **Usage dashboard** | `/usage` shows a persistent ledger: tasks, tokens, cache rate, cost, and cache *savings* — for this session, today, and all time, plus totals across every project on the machine. Costs use each model's own rates, including its exact cache read/write prices, so a history spanning a model switch stays accurate. Prices ship built in and update with `/usage --refresh-prices`. Records live in `.faber/usage.db` per project and survive restarts. |
|
|
88
129
|
| **Error recovery** | Transient API errors: backoff + jitter, honors Retry-After. Tool errors return to the model to self-correct. Identical call failing twice → warning; three times → clean abort. Ctrl-C aborts streams *and* running commands; checkpoints survive. |
|
|
89
130
|
| **Safety rails** | Symlink-resolved path jail, shell denylist, timeouts, output truncation, atomic writes (temp+rename), stale-edit guard. Guardrails, not a sandbox — use a container for untrusted code. |
|
|
90
131
|
|
|
132
|
+
## Vendors, routes, and models
|
|
133
|
+
|
|
134
|
+
Faber separates three choices, so you can change one without redoing the others:
|
|
135
|
+
|
|
136
|
+
| Level | What it decides | How you set it |
|
|
137
|
+
|---|---|---|
|
|
138
|
+
| **Vendor** | who makes the model | `/route` |
|
|
139
|
+
| **Route** | how you reach it and who owns auth | `/route` |
|
|
140
|
+
| **Model** | which model on that route | `/model` |
|
|
141
|
+
|
|
142
|
+
Routes available today: **Anthropic API**, **Amazon Bedrock**, **OpenAI API**, **Ollama** (local, no key and no cost), and any **OpenAI-compatible endpoint** (OpenRouter, Groq, Together, vLLM, a gateway). Google Vertex is defined but not yet wired up — `/route` says so rather than failing at request time.
|
|
143
|
+
|
|
144
|
+
### Amazon Bedrock
|
|
145
|
+
|
|
146
|
+
Faber authenticates two ways, and tries them in this order.
|
|
147
|
+
|
|
148
|
+
**With an IAM role, which needs no key at all.** In SageMaker Studio, on EC2, in ECS or Lambda, or on a laptop where you've run `aws configure`, Faber finds your AWS credentials the same way the SDKs do and signs each request with SigV4. Pick Amazon Bedrock during setup, give it a region, and that's the whole configuration. The signing is implemented directly against Node's crypto module rather than pulling in the AWS SDK, so the zero-dependency install still holds, and it's verified against the signature AWS publishes for its own worked example.
|
|
149
|
+
|
|
150
|
+
**With a Bedrock API key**, if you'd rather use one:
|
|
151
|
+
|
|
152
|
+
```bash
|
|
153
|
+
export BEDROCK_API_KEY=...
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
Model ids on Bedrock differ by region and deployment, so pin them per alias in your profile instead of relying on the built-in names:
|
|
157
|
+
|
|
158
|
+
```json
|
|
159
|
+
{ "route": "bedrock", "region": "us-west-2",
|
|
160
|
+
"modelPins": { "sonnet": "anthropic.claude-sonnet-4-6-v1" },
|
|
161
|
+
"apiKeyEnv": "BEDROCK_API_KEY" }
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
### Costs
|
|
165
|
+
|
|
166
|
+
`/usage` shows real dollars without any configuration. Prices come from the best source available, in this order: whatever you set explicitly, then the provider's own published rates (OpenRouter publishes per-token prices including cache reads and writes, and needs no key for it), then a community dataset covering everyone else, then a small table built into Faber so it still works offline. Anthropic and OpenAI don't publish prices through their APIs at all, which is why the last two exist.
|
|
167
|
+
|
|
168
|
+
```
|
|
169
|
+
faber> /usage --refresh-prices # pull current rates now
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
Keeping those rates current matters more than it might sound, because a task's cost is written down when the task runs and never recalculated. If a vendor raises prices next month, last month's tasks still show what they actually cost. That's the point of a ledger. But it also means a stale price table would bake a wrong number into your history permanently, so Faber fetches prices once during setup and re-checks on every launch using a conditional request. When nothing has changed the server answers with a 304 and no body, which costs about 70ms in the background, so there's no window where an out-of-date rate can slip into your records. The full download only happens when the price list actually changes, and after a failed attempt Faber waits a day before trying again so an offline machine isn't making a doomed request every time you start.
|
|
173
|
+
|
|
174
|
+
You can turn the automatic refresh off with `FABER_AUTO_PRICES=0` or `"autoRefreshPrices": false` in your profile, in which case Faber falls back to its built-in rates and mentions at startup when they're getting old. This is the only network request Faber makes that isn't an inference call. It fetches a public price list and sends nothing about you.
|
|
175
|
+
|
|
176
|
+
Costs use each model's own input, output, cache-read and cache-write rates rather than a flat multiplier, and cloud model ids like `us.anthropic.claude-sonnet-5` normalize onto the same entry as the direct one. Setting `FABER_PRICE_IN` and `FABER_PRICE_OUT`, or `priceIn` and `priceOut` in a profile, overrides everything. A model with no known price shows a dash rather than a guess.
|
|
177
|
+
|
|
178
|
+
Settings live in `~/.faber/settings.json` as named **profiles**:
|
|
179
|
+
|
|
180
|
+
```json
|
|
181
|
+
{
|
|
182
|
+
"activeProfile": "work",
|
|
183
|
+
"profiles": {
|
|
184
|
+
"work": { "route": "anthropic-api", "model": "sonnet", "apiKeyEnv": "ANTHROPIC_API_KEY_WORK" },
|
|
185
|
+
"local": { "route": "ollama", "model": "qwen2.5-coder" }
|
|
186
|
+
}
|
|
187
|
+
}
|
|
188
|
+
```
|
|
189
|
+
|
|
190
|
+
Profiles store the name of the environment variable holding your credential, never the credential itself, so the file is safe to sync between machines or keep in a dotfiles repo. Switch between them with `/profile local`.
|
|
191
|
+
|
|
192
|
+
Settings resolve in this order, highest first: environment variables, then a project's `.faber/config.json`, then the active profile, then defaults. So a repo can pin its own model while your machine default stays whatever you picked, and an environment variable still overrides both.
|
|
193
|
+
|
|
91
194
|
## Commands
|
|
92
195
|
|
|
93
196
|
```
|
|
197
|
+
/setup run setup again (vendor, route, credential, model)
|
|
198
|
+
/route choose a vendor and route
|
|
199
|
+
/model [alias] switch model; lists what your key can actually use
|
|
200
|
+
/key [set|rm] show, save or remove an API key
|
|
201
|
+
/profile [name] list or switch saved profiles
|
|
202
|
+
/usage tokens, cost and cache savings (--refresh-prices)
|
|
94
203
|
/index rebuild the code graph (symbols + call edges)
|
|
95
204
|
/map <symbol> print the call tree from any entry point
|
|
96
205
|
/memory [archived] long-term memories (+ file notes)
|
|
@@ -101,6 +210,7 @@ Any OpenAI-compatible provider: `FABER_PROVIDER=openai`, `OPENAI_API_KEY`, `FABE
|
|
|
101
210
|
/history task checkpoints /restore <id>
|
|
102
211
|
/undo /redo revert last task / bring it back
|
|
103
212
|
/ask /auto toggle approval mode
|
|
213
|
+
/verbose /concise full-depth answers, or short ones (default concise)
|
|
104
214
|
/clear /help /exit
|
|
105
215
|
```
|
|
106
216
|
|
|
@@ -115,15 +225,19 @@ Flags: `faber [task] [--workspace|-w <dir>] [--resume] [--ask|--auto] [--version
|
|
|
115
225
|
| `FABER_MODEL`, `FABER_BASE_URL` | model + endpoint overrides |
|
|
116
226
|
| `FABER_APPROVAL` | `ask` \| `auto` (ask) |
|
|
117
227
|
| `FABER_GIT` | `commit` = one commit per task (off) |
|
|
118
|
-
| `FABER_PRICE_IN`, `FABER_PRICE_OUT` | $/Mtok
|
|
228
|
+
| `FABER_PRICE_IN`, `FABER_PRICE_OUT` | $/Mtok, overrides the built-in price table |
|
|
119
229
|
| `FABER_WEAK_MODEL` | cheap model for internal summarization (e.g. a Haiku-class model) |
|
|
120
230
|
| `FABER_MAX_ITERATIONS` | loop cap (40) |
|
|
121
231
|
| `FABER_CONTEXT_BUDGET` | compaction threshold, tokens (60000) |
|
|
122
232
|
| `FABER_SHELL_TIMEOUT` | ms (120000) |
|
|
233
|
+
| `FABER_ROUTE`, `FABER_REGION` | route id and region, overriding the profile |
|
|
234
|
+
| `FABER_AUTO_PRICES` | `0` disables the background price refresh |
|
|
235
|
+
| `BEDROCK_API_KEY` | Bedrock, when you'd rather use a key than an IAM role |
|
|
236
|
+
| `AWS_ACCESS_KEY_ID` etc. | picked up automatically for Bedrock's SigV4 signing |
|
|
123
237
|
|
|
124
|
-
|
|
238
|
+
Faber keeps three files. `~/.faber/settings.json` holds your profiles, which is the route, model and which environment variable a credential comes from. `~/.faber/credentials.json` holds the keys themselves, owner-only and outside every repository. A project can override the profile with its own `.faber/config.json`, which is useful when one repo should use a cheaper model than the rest.
|
|
125
239
|
|
|
126
|
-
|
|
240
|
+
Commit protection happens on its own. When Faber starts inside a git repo it writes `.faber/` into `.git/info/exclude`, a local ignore that produces no diff and is never committed, so project state can't reach GitHub even if you forget your `.gitignore`. If `.faber/` was already committed at some point in the past, you get a loud warning with the exact `git rm --cached` command to fix it. This matters because sessions and checkpoints can contain the contents of files the agent read. If teammates will use Faber too, add `.faber/` to the shared `.gitignore` so they're covered from their first run.
|
|
127
241
|
|
|
128
242
|
## Failure-mode matrix
|
|
129
243
|
|
|
@@ -148,13 +262,13 @@ Per-project overrides: `.faber/config.json`.
|
|
|
148
262
|
## Testing
|
|
149
263
|
|
|
150
264
|
```bash
|
|
151
|
-
npm test #
|
|
265
|
+
npm test # offline test suite, no API key needed
|
|
152
266
|
node selftest.mjs # installation self-check + live agent verification (report file to share)
|
|
153
267
|
```
|
|
154
268
|
|
|
155
|
-
The suite covers the awkward
|
|
269
|
+
The suite deliberately covers the awkward cases rather than the easy ones: undo and redo round-trips, checkpoint ids colliding within the same millisecond, session files torn mid-write, cyclic call graphs, surgical edits through CRLF and emoji, cancellation mid-stream, steering messages keeping the API's role alternation valid, paste markers split across stream chunks, AWS signatures checked against the vector AWS publishes, credential files landing with owner-only permissions, and a recorded cost staying put when prices later change. Several tests drive the real agent loop against a mock streaming server, and one drives the actual CLI binary.
|
|
156
270
|
|
|
157
|
-
CI
|
|
271
|
+
CI runs on Ubuntu, macOS and Windows across Node 22 and 24: tests, build, and CLI smoke on every push.
|
|
158
272
|
|
|
159
273
|
## Architecture
|
|
160
274
|
|
|
@@ -174,7 +288,7 @@ All state in <repo>/.faber/ (memory.db, index.db, sessions/, checkpoints/)
|
|
|
174
288
|
|
|
175
289
|
## Roadmap
|
|
176
290
|
|
|
177
|
-
|
|
291
|
+
Google Vertex is defined but not yet wired up, since its OAuth flow is a bigger piece than Bedrock turned out to be. Beyond that: tree-sitter for compiler-grade graph edges, evicting stale tool results from long conversations, redacting secrets in session logs, team-shared project settings that can live in a repo, embedding-based recall, a branch-per-task git mode, and a VS Code extension built on this core.
|
|
178
292
|
|
|
179
293
|
## License
|
|
180
294
|
|
package/dist/agent.js
CHANGED
|
@@ -42,6 +42,9 @@ export class Agent {
|
|
|
42
42
|
events;
|
|
43
43
|
/** Verbose mode: user asked for full-depth explanations (/verbose). */
|
|
44
44
|
verbose = false;
|
|
45
|
+
/** Active model. Switching mid-session invalidates the prompt cache, since
|
|
46
|
+
* cached prefixes are per-model — the next task pays full price once. */
|
|
47
|
+
model;
|
|
45
48
|
/** Mid-task steering: lines typed while the agent works, injected at the
|
|
46
49
|
* next loop boundary so the model course-corrects without cancelling. */
|
|
47
50
|
steerQueue = [];
|
|
@@ -57,6 +60,7 @@ export class Agent {
|
|
|
57
60
|
constructor(config, approve, events = {}, resumeSessionId, askUser) {
|
|
58
61
|
this.config = config;
|
|
59
62
|
this.events = events;
|
|
63
|
+
this.model = config.model;
|
|
60
64
|
this.llm = new LLMClient(config);
|
|
61
65
|
this.usage = new UsageLedger(config.usageDb, config.workspace);
|
|
62
66
|
this.checkpoints = new CheckpointManager(config.stateDir, config.workspace);
|
|
@@ -73,6 +77,10 @@ export class Agent {
|
|
|
73
77
|
this.events.onInfo?.(`Resumed session ${resumeSessionId} (${restored.length} messages).`);
|
|
74
78
|
}
|
|
75
79
|
}
|
|
80
|
+
setModel(id) {
|
|
81
|
+
this.model = id;
|
|
82
|
+
this.llm.setModel(id);
|
|
83
|
+
}
|
|
76
84
|
steer(text) {
|
|
77
85
|
const t = text.trim();
|
|
78
86
|
if (t)
|
|
@@ -191,7 +199,7 @@ export class Agent {
|
|
|
191
199
|
finally {
|
|
192
200
|
this.checkpoints.commit();
|
|
193
201
|
if (total.calls > 0) {
|
|
194
|
-
this.usage.record(total, this.config.
|
|
202
|
+
this.usage.record(total, this.model, { in: this.config.priceIn, out: this.config.priceOut });
|
|
195
203
|
this.events.onUsage?.(total);
|
|
196
204
|
}
|
|
197
205
|
}
|
package/dist/config.js
CHANGED
|
@@ -7,6 +7,9 @@
|
|
|
7
7
|
*/
|
|
8
8
|
import * as fs from "node:fs";
|
|
9
9
|
import * as path from "node:path";
|
|
10
|
+
import { loadSettings, activeProfile } from "./settings.js";
|
|
11
|
+
import { getRoute, resolveModel, baseUrlFor, ROUTES } from "./routes.js";
|
|
12
|
+
import { resolveCredential, getCredential } from "./credentials.js";
|
|
10
13
|
export const DEFAULT_ANTHROPIC_MODEL = "claude-sonnet-4-5";
|
|
11
14
|
export const DEFAULT_OPENAI_MODEL = "gpt-4o";
|
|
12
15
|
/** Accept both FABER_* (canonical) and CW_* (legacy) env var names. */
|
|
@@ -42,16 +45,45 @@ export function loadConfig(workspace) {
|
|
|
42
45
|
catch { /* ignore malformed */ }
|
|
43
46
|
}
|
|
44
47
|
const s = (k) => typeof fileCfg[k] === "string" ? fileCfg[k] : undefined;
|
|
45
|
-
|
|
48
|
+
// Global profile sits below project config and above defaults.
|
|
49
|
+
const settings = loadSettings();
|
|
50
|
+
const prof = activeProfile(settings);
|
|
51
|
+
const route = getRoute(process.env.FABER_ROUTE ?? s("route") ?? prof.route) ?? ROUTES[0];
|
|
52
|
+
const pins = { ...(prof.modelPins ?? {}), ...(fileCfg["modelPins"] ?? {}) };
|
|
53
|
+
// The route decides the wire format unless a provider is set explicitly.
|
|
54
|
+
const provider = (process.env.CW_PROVIDER ?? s("provider") ?? route.wire).toLowerCase();
|
|
46
55
|
const anthropic = provider === "anthropic";
|
|
56
|
+
const rawModel = process.env.CW_MODEL ?? s("model") ?? prof.model
|
|
57
|
+
?? (anthropic ? DEFAULT_ANTHROPIC_MODEL : DEFAULT_OPENAI_MODEL);
|
|
58
|
+
// Env var first, then the 0600 credential store — unless the profile says
|
|
59
|
+
// the stored key was chosen deliberately, in which case honour that.
|
|
60
|
+
const keyFromProfile = prof.apiKeyEnv
|
|
61
|
+
? (prof.preferStoredKey
|
|
62
|
+
? (getCredential(prof.apiKeyEnv) ?? resolveCredential(prof.apiKeyEnv))
|
|
63
|
+
: resolveCredential(prof.apiKeyEnv))
|
|
64
|
+
: undefined;
|
|
65
|
+
const region = process.env.FABER_REGION ?? s("region") ?? prof.region;
|
|
66
|
+
const routeUrl = baseUrlFor(route, region);
|
|
67
|
+
// A route-specific credential (e.g. BEDROCK_API_KEY) wins over the generic one.
|
|
68
|
+
const routeKey = route.keyEnv
|
|
69
|
+
? (prof.preferStoredKey ? (getCredential(route.keyEnv) ?? resolveCredential(route.keyEnv))
|
|
70
|
+
: resolveCredential(route.keyEnv))
|
|
71
|
+
: undefined;
|
|
47
72
|
return {
|
|
48
73
|
workspace: ws,
|
|
49
74
|
stateDir,
|
|
50
75
|
provider,
|
|
51
|
-
model:
|
|
52
|
-
baseUrl: process.env.CW_BASE_URL ?? s("baseUrl") ??
|
|
53
|
-
|
|
54
|
-
|
|
76
|
+
model: resolveModel(rawModel, route, pins),
|
|
77
|
+
baseUrl: process.env.CW_BASE_URL ?? s("baseUrl") ?? prof.baseUrl ?? routeUrl
|
|
78
|
+
?? (anthropic ? "https://api.anthropic.com" : "https://api.openai.com/v1"),
|
|
79
|
+
// A route that names its own credential (BEDROCK_API_KEY) must NOT fall
|
|
80
|
+
// back to the generic one: sending an Anthropic key to Bedrock produces a
|
|
81
|
+
// confusing 401 and hides the fact that AWS signing was available.
|
|
82
|
+
apiKey: routeKey ?? keyFromProfile ?? s("apiKey")
|
|
83
|
+
?? (route.keyEnv
|
|
84
|
+
? undefined
|
|
85
|
+
: resolveCredential(anthropic ? "ANTHROPIC_API_KEY" : "OPENAI_API_KEY")),
|
|
86
|
+
weakModel: process.env.CW_WEAK_MODEL ?? s("weakModel") ?? prof.weakModel,
|
|
55
87
|
maxTokens: 4096,
|
|
56
88
|
maxIterations: Number(process.env.CW_MAX_ITERATIONS ?? fileCfg["maxIterations"] ?? 40),
|
|
57
89
|
contextTokenBudget: Number(process.env.CW_CONTEXT_BUDGET ?? fileCfg["contextTokenBudget"] ?? 60_000),
|
|
@@ -64,5 +96,16 @@ export function loadConfig(workspace) {
|
|
|
64
96
|
indexDb: path.join(stateDir, "index.db"),
|
|
65
97
|
sessionsDir: path.join(stateDir, "sessions"),
|
|
66
98
|
usageDb: path.join(stateDir, "usage.db"),
|
|
99
|
+
route: route.id,
|
|
100
|
+
region,
|
|
101
|
+
modelPins: pins,
|
|
102
|
+
profileName: settings.activeProfile,
|
|
103
|
+
priceIn: Number(process.env.FABER_PRICE_IN) || prof.priceIn,
|
|
104
|
+
// On by default: costs are frozen per task, so silently stale prices would
|
|
105
|
+
// corrupt history permanently. Opt out with FABER_AUTO_PRICES=0.
|
|
106
|
+
autoRefreshPrices: process.env.FABER_AUTO_PRICES === "0" ? false
|
|
107
|
+
: process.env.FABER_AUTO_PRICES === "1" ? true
|
|
108
|
+
: prof.autoRefreshPrices !== false,
|
|
109
|
+
priceOut: Number(process.env.FABER_PRICE_OUT) || prof.priceOut,
|
|
67
110
|
};
|
|
68
111
|
}
|
|
@@ -0,0 +1,134 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Credential storage: ~/.faber/credentials.json, mode 0600.
|
|
3
|
+
*
|
|
4
|
+
* Deliberately OUTSIDE any project directory. A key written next to your code
|
|
5
|
+
* is one `git add -f`, one bad .gitignore, or one shared zip away from being
|
|
6
|
+
* public — and scanning bots find committed keys in minutes. Every tool that
|
|
7
|
+
* handles this well (aws, gcloud, npm, git) keeps secrets in the home
|
|
8
|
+
* directory and lets project config reference them by name.
|
|
9
|
+
*
|
|
10
|
+
* Resolution order for a credential:
|
|
11
|
+
* 1. the environment variable (CI, one-offs, and existing setups keep working)
|
|
12
|
+
* 2. this file, keyed by the same variable name
|
|
13
|
+
* Nothing else. Faber never writes a secret into a workspace.
|
|
14
|
+
*/
|
|
15
|
+
import * as fs from "node:fs";
|
|
16
|
+
import * as os from "node:os";
|
|
17
|
+
import * as path from "node:path";
|
|
18
|
+
export function credentialsPath() {
|
|
19
|
+
return path.join(os.homedir(), ".faber", "credentials.json");
|
|
20
|
+
}
|
|
21
|
+
function read(file = credentialsPath()) {
|
|
22
|
+
try {
|
|
23
|
+
const raw = JSON.parse(fs.readFileSync(file, "utf8"));
|
|
24
|
+
if (!raw || typeof raw !== "object" || Array.isArray(raw))
|
|
25
|
+
return {};
|
|
26
|
+
const out = {};
|
|
27
|
+
for (const [k, v] of Object.entries(raw)) {
|
|
28
|
+
if (typeof v === "string")
|
|
29
|
+
out[k] = v;
|
|
30
|
+
}
|
|
31
|
+
return out;
|
|
32
|
+
}
|
|
33
|
+
catch {
|
|
34
|
+
return {};
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
/** Look up a stored credential by the env var name it stands in for. */
|
|
38
|
+
export function getCredential(envName, file = credentialsPath()) {
|
|
39
|
+
return read(file)[envName];
|
|
40
|
+
}
|
|
41
|
+
/** Env var wins, so CI and existing shells are never overridden by a saved key. */
|
|
42
|
+
export function resolveCredential(envName, file = credentialsPath()) {
|
|
43
|
+
return process.env[envName] ?? getCredential(envName, file);
|
|
44
|
+
}
|
|
45
|
+
/** Where a credential came from — so Faber can say so instead of using it silently. */
|
|
46
|
+
export function credentialSource(envName, file = credentialsPath()) {
|
|
47
|
+
const env = process.env[envName];
|
|
48
|
+
if (env)
|
|
49
|
+
return { value: env, from: "environment" };
|
|
50
|
+
const stored = getCredential(envName, file);
|
|
51
|
+
return stored ? { value: stored, from: "store" } : undefined;
|
|
52
|
+
}
|
|
53
|
+
/**
|
|
54
|
+
* Save a credential with owner-only permissions. Written to a temp file first
|
|
55
|
+
* and renamed, so a crash can't leave a half-written store — and chmod happens
|
|
56
|
+
* before the secret lands, never after.
|
|
57
|
+
*/
|
|
58
|
+
export function saveCredential(envName, value, file = credentialsPath()) {
|
|
59
|
+
const dir = path.dirname(file);
|
|
60
|
+
fs.mkdirSync(dir, { recursive: true, mode: 0o700 });
|
|
61
|
+
const store = read(file);
|
|
62
|
+
store[envName] = value;
|
|
63
|
+
const tmp = `${file}.tmp-${process.pid}`;
|
|
64
|
+
fs.writeFileSync(tmp, JSON.stringify(store, null, 2) + "\n", { mode: 0o600 });
|
|
65
|
+
try {
|
|
66
|
+
fs.rmSync(file, { force: true });
|
|
67
|
+
}
|
|
68
|
+
catch { /* absent is fine */ }
|
|
69
|
+
fs.renameSync(tmp, file); // rename onto an existing file fails on Windows
|
|
70
|
+
try {
|
|
71
|
+
fs.chmodSync(file, 0o600);
|
|
72
|
+
}
|
|
73
|
+
catch { /* no-op where modes don't apply */ }
|
|
74
|
+
}
|
|
75
|
+
export function deleteCredential(envName, file = credentialsPath()) {
|
|
76
|
+
const store = read(file);
|
|
77
|
+
if (!(envName in store))
|
|
78
|
+
return false;
|
|
79
|
+
delete store[envName];
|
|
80
|
+
const tmp = `${file}.tmp-${process.pid}`;
|
|
81
|
+
fs.writeFileSync(tmp, JSON.stringify(store, null, 2) + "\n", { mode: 0o600 });
|
|
82
|
+
try {
|
|
83
|
+
fs.rmSync(file, { force: true });
|
|
84
|
+
}
|
|
85
|
+
catch { /* absent is fine */ }
|
|
86
|
+
fs.renameSync(tmp, file);
|
|
87
|
+
return true;
|
|
88
|
+
}
|
|
89
|
+
/** Names of stored credentials — never the values. */
|
|
90
|
+
export function listCredentialNames(file = credentialsPath()) {
|
|
91
|
+
return Object.keys(read(file)).sort();
|
|
92
|
+
}
|
|
93
|
+
/**
|
|
94
|
+
* Does this look like a real key for that variable?
|
|
95
|
+
* Deliberately loose — formats change, and refusing a valid key is worse than
|
|
96
|
+
* accepting an odd one. This only catches obvious mistakes: a typo, a pasted
|
|
97
|
+
* filename, an accidental keystroke. Returns a reason when it looks wrong.
|
|
98
|
+
*/
|
|
99
|
+
export function looksLikeKey(envName, value) {
|
|
100
|
+
const v = value.trim();
|
|
101
|
+
if (v.length < 20)
|
|
102
|
+
return "that looks too short for an API key";
|
|
103
|
+
if (/\s/.test(v))
|
|
104
|
+
return "that contains spaces";
|
|
105
|
+
if (envName === "ANTHROPIC_API_KEY" && !v.startsWith("sk-ant-")) {
|
|
106
|
+
return "Anthropic keys normally start with sk-ant-";
|
|
107
|
+
}
|
|
108
|
+
if (envName === "OPENAI_API_KEY" && !v.startsWith("sk-")) {
|
|
109
|
+
return "OpenAI keys normally start with sk-";
|
|
110
|
+
}
|
|
111
|
+
return undefined;
|
|
112
|
+
}
|
|
113
|
+
/** Show a key without exposing it: sk-ant-…4f2a */
|
|
114
|
+
export function maskCredential(value) {
|
|
115
|
+
if (value.length <= 12)
|
|
116
|
+
return "…".repeat(Math.max(1, value.length - 2)) + value.slice(-2);
|
|
117
|
+
return `${value.slice(0, 7)}…${value.slice(-4)}`;
|
|
118
|
+
}
|
|
119
|
+
/**
|
|
120
|
+
* True when the file is readable by anyone but the owner.
|
|
121
|
+
* Windows has no POSIX mode bits — Node reports a synthetic value there, so
|
|
122
|
+
* checking it would warn every Windows user on every launch. Access control
|
|
123
|
+
* on that platform comes from NTFS ACLs, which this can't inspect.
|
|
124
|
+
*/
|
|
125
|
+
export function permissionsAreLoose(file = credentialsPath()) {
|
|
126
|
+
if (process.platform === "win32")
|
|
127
|
+
return false;
|
|
128
|
+
try {
|
|
129
|
+
return (fs.statSync(file).mode & 0o077) !== 0;
|
|
130
|
+
}
|
|
131
|
+
catch {
|
|
132
|
+
return false;
|
|
133
|
+
}
|
|
134
|
+
}
|