Skip to content
Merged
Changes from 1 commit
Commits
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
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,13 @@ conduit --help

Conduit uses a `conduit.toml` file as its configuration file.

Create a `conduit.toml` file in your working directory, otherwise Conduit will not be able to run.
By default Conduit reads `conduit.toml` from the working directory. To keep the config somewhere else, pass `--config <path>` (`-c`) or set the `CONDUIT_CONFIG` environment variable. This works for both `conduit proxy` and `conduit dashboard`:
Comment thread
ruksi marked this conversation as resolved.
Resolved

```shell
conduit --config ~/.config/conduit/conduit.toml proxy
```

Conduit won't start without a config that defines at least one `[providers.<name>]` section.
Comment thread
Copilot marked this conversation as resolved.
Resolved

You can copy the example [from here](https://github.com/valohai/conduit/blob/main/conduit.example.toml) and adjust where Conduit will be listening to LLM calls and setup the providers you are using.

Expand Down Expand Up @@ -99,6 +105,18 @@ client = Anthropic(base_url="http://localhost:8080/anthropic")

See [`examples/`](https://github.com/valohai/conduit/tree/main/examples) for complete Python usage examples.

### Check that it works

With `conduit proxy` running, send a request through it. You don't need an API key for this check:
Comment thread
ruksi marked this conversation as resolved.
Resolved

```shell
curl -s -o /dev/null -w "%{http_code}\n" http://localhost:8080/anthropic/v1/models
Comment thread
ruksi marked this conversation as resolved.
Resolved
Comment thread
Copilot marked this conversation as resolved.
Resolved
```

A `401` means the request went through Conduit and reached the provider, which rejected it for having no key. A `404` usually means the provider name in the URL doesn't match a `[providers.<name>]` section. A connection error means Conduit isn't running or is listening on another address.

Run your code with real keys, then open `conduit dashboard` to see tokens and cost per call.

## Development

See the [contributing guide](https://github.com/valohai/conduit?tab=contributing-ov-file) to get started.
Loading