From 453fd358361a8d3f5c0ccb58bfda8bb856408b28 Mon Sep 17 00:00:00 2001 From: jakearmstrong59 Date: Sun, 12 Jul 2026 18:30:44 +0000 Subject: [PATCH] docs: document miner coding-agent env vars --- packages/gittensory-miner/DEPLOYMENT.md | 13 +++++++++++++ packages/gittensory-miner/README.md | 14 ++++++++++++++ 2 files changed, 27 insertions(+) diff --git a/packages/gittensory-miner/DEPLOYMENT.md b/packages/gittensory-miner/DEPLOYMENT.md index f64f692075..744f2e164d 100644 --- a/packages/gittensory-miner/DEPLOYMENT.md +++ b/packages/gittensory-miner/DEPLOYMENT.md @@ -10,6 +10,19 @@ Two form factors for running `@jsonbored/gittensory-miner`: **laptop mode** (sin | **Setup** | `npm install -g @jsonbored/gittensory-miner` or workspace build | `docker build` + `docker run` with env + volume (see below) | | **Footprint** | One Node process, local disk for ledgers/queues | One container per worker; scale horizontally by adding containers | +## Coding-agent provider configuration + +For provider selection and model/timeout knobs, see the README section on +[coding-agent driver configuration](README.md#coding-agent-driver-configuration) and the +interface-level contract in [`docs/coding-agent-driver.md`](docs/coding-agent-driver.md). +The short version is: + +- `MINER_CODING_AGENT_PROVIDER` is a comma-separated preference list; the first configured name wins. +- Valid provider names are `noop`, `claude-cli`, `codex-cli`, and `agent-sdk`. +- `MINER_CODING_AGENT_CLAUDE_MODEL` and `MINER_CODING_AGENT_CODEX_MODEL` only affect their matching CLI providers. +- `MINER_CODING_AGENT_TIMEOUT_MS` only affects the CLI providers and falls back to `120000` ms when unset or invalid. +- `noop` and `agent-sdk` ignore the model and timeout knobs. + ## Laptop mode walkthrough 1. Install Node.js 22.13+ and the package: diff --git a/packages/gittensory-miner/README.md b/packages/gittensory-miner/README.md index 81905161f0..c4aa8f4df1 100644 --- a/packages/gittensory-miner/README.md +++ b/packages/gittensory-miner/README.md @@ -114,6 +114,20 @@ npm --workspace @jsonbored/gittensory-miner run build npm link --workspace @jsonbored/gittensory-miner ``` +### Coding-agent driver configuration + +The production driver is selected by `MINER_CODING_AGENT_PROVIDER`. The value is a comma-separated preference list: +the first configured name wins, unknown names are skipped, and an empty/unset list leaves production driver +construction fail-closed. See [`docs/coding-agent-driver.md`](docs/coding-agent-driver.md) for the interface-level +contract and provider behavior. + +| Env var | Accepted values | Default / behavior | +| --- | --- | --- | +| `MINER_CODING_AGENT_PROVIDER` | `noop`, `claude-cli`, `codex-cli`, `agent-sdk` | Unset / empty means no provider is configured; the miner fails closed until a valid provider name is supplied. | +| `MINER_CODING_AGENT_CLAUDE_MODEL` | Any Claude model string accepted by the local `claude` CLI | Unset means `claude-cli` uses the CLI's own default model. Ignored by `noop`, `codex-cli`, and `agent-sdk`. | +| `MINER_CODING_AGENT_CODEX_MODEL` | Any Codex model string accepted by the local `codex` CLI | Unset means `codex-cli` uses the CLI's own default model. Ignored by `noop`, `claude-cli`, and `agent-sdk`. | +| `MINER_CODING_AGENT_TIMEOUT_MS` | Positive integer milliseconds | Unset or invalid falls back to the CLI driver's default wall-clock timeout of `120000` ms. Ignored by `noop` and `agent-sdk`. | + ## Commands ```sh