Skip to content

docs(miner): document coding-agent env vars #5423

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
loopover-orb merged 1 commit into from
Jul 12, 2026
Merged

docs(miner): document coding-agent env vars #5423

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions packages/gittensory-miner/DEPLOYMENT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
14 changes: 14 additions & 0 deletions packages/gittensory-miner/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down