Repository navigation
📝 Document --config and add a "Check that it works" step to the README - #38
Merged
Merged
Conversation
The README said conduit.toml must be in the working directory, but --config / CONDUIT_CONFIG already exist. Also add a keyless curl check that tells a working proxy (401) apart from a wrong provider name (404) and a proxy that isn't running (connection error). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
ruksi
reviewed
Nov 17, 2026
`-s` alone hides them and prints only `000`; list each status code the check can return, including `502` for an unreachable upstream
There was a problem hiding this comment.
🟡 Changes recommended
The README still misstates the dashboard’s provider requirement and omits important configuration and curl-check details.
4 open issues
What changed in this PR
Improves Conduit’s setup documentation by explaining external configuration files and adding an end-to-end proxy check. No runtime code changes are included.
Changes:
- Documents
--config/-c,CONDUIT_CONFIG, and provider configuration requirements. - Adds a keyless
curlcheck with troubleshooting guidance and a dashboard follow-up.
| File | Description |
|---|---|
README.md |
Expands configuration guidance and adds a proxy verification walkthrough. |
Review effort: Balanced
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

What changed
conduit.tomlin the working directory. It now documents--config/-candCONDUIT_CONFIG, which already exist inconduit --help, and says a config needs at least one[providers.<name>]section.curlthrough the proxy. A401means the request reached the provider, a404means the provider name doesn't match, and a connection error means Conduit isn't running.I checked these against Conduit 0.3.0: a known provider returns 401, an unknown one 404, and
CONDUIT_CONFIGis read.Why
We ran coding agents (Claude Code and Codex) through Conduit setup tasks with Gauge.
--configby running--help. Agents that read only the README would conclude Conduit must run from a project folder.These are small samples (1 session per case per agent), so treat this as directional.
Related: #37 (a failed start with no providers leaves
conduit.dbbehind). That needs a code fix and isn't covered here.🤖 Generated with Claude Code