Skip to content

📝 Document --config and add a "Check that it works" step to the README - #38

Merged
ruksi merged 3 commits into
mainfrom
docs/readme-config-and-verify
Nov 17, 2026
Merged

ruksi merged 3 commits into
mainfrom
docs/readme-config-and-verify

Conversation

@petterir

Copy link
Copy Markdown
Collaborator

What changed

  • Configuration: the README said Conduit only runs with a conduit.toml in the working directory. It now documents --config / -c and CONDUIT_CONFIG, which already exist in conduit --help, and says a config needs at least one [providers.<name>] section.
  • New "Check that it works" section: a keyless curl through the proxy. A 401 means the request reached the provider, a 404 means 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_CONFIG is read.

Why

We ran coding agents (Claude Code and Codex) through Conduit setup tasks with Gauge.

  • Config location: agents only found --config by running --help. Agents that read only the README would conclude Conduit must run from a project folder.
  • Testing the setup: in the first pilot, one agent wrote a working config but never sent a request through the proxy. After this README change, agents ran the end-to-end check in that case on both Claude Code and Codex.

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.db behind). That needs a code fix and isn't covered here.

🤖 Generated with Claude Code

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>
@petterir
petterir requested a review from ruksi November 17, 2026 12:06
@ruksi
ruksi requested a balanced review from Copilot November 17, 2026 13:10
Comment thread README.md Resolved
`-s` alone hides them and prints only `000`; list each status code
the check can return, including `502` for an unreachable upstream

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 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 curl check with troubleshooting guidance and a dashboard follow-up.
File Description
README.md Expands configuration guidance and adds a proxy verification walkthrough.

Review effort: Balanced

Comment thread README.md Resolved
Comment thread README.md Resolved
Comment thread README.md Resolved
Comment thread README.md Resolved

@ruksi ruksi left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm! should improve things

@ruksi
ruksi merged commit 1c148fe into main Nov 17, 2026
8 checks passed
@ruksi
ruksi deleted the docs/readme-config-and-verify branch November 17, 2026 13:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants