cowprotocol / cowprotocol/docs
bug:
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 5
- Forks
- 32
- PR merge metrics
- No merged PRs in 30d
Description
Problem
A clear and concise description of what the bug is.
The documentation for locally testing a solver is stale. The autopilot binary's CLI interface has changed — it no longer accepts individual flags and now only accepts a --config <CONFIG> file path.
I ran this command from the docs:
cargo run --bin autopilot -- --native-price-estimators "baseline|http://driver/baseline" --skip-event-sync true --node-url $NODE_URL --shadow https://api.cow.fi/mainnet --drivers "mysolver1|http://localhost:11088/mysolver1"`
And got this error:
error: unexpected argument '--native-price-estimators' found
Usage: autopilot --config <CONFIG>
For more information, try '--help'.
Confirmed via --help that --config is the only supported top-level option:
➜ services git:(main) cargo run --bin autopilot -- --help
Finished `dev` profile [unoptimized + debuginfo] target(s) in 1.23s
Running `target/debug/autopilot --help`
Usage: autopilot --config <CONFIG>
Options:
--config <CONFIG> [env: CONFIG=]
-h, --help Print help
To reproduce
If you can reproduce the behaviour, steps to reproduce:
gh repo clone cowprotocol/servicescd services- Run the command from the docs (quoted above)
- See error
Expected behaviour
Either the command runs successfully as documented, or the docs are updated to reflect the current --config <CONFIG>-based interface. Alternatively, the docs could point users directly to the playground/docker-compose.fork.yml setup, which appears to be the currently-maintained way to run the local stack (autopilot, driver, orderbook, Postgres, and a forked chain) and may make the manual cargo run instructions obsolete entirely.
Screenshots/logs
See error output above.
docs version/commit hash
Additional context
The repo's playground/ directory (docker-compose.fork.yml + .env) seems to be the currently-maintained way to spin up the local stack, which suggests the doc's manual cargo run --bin autopilot -- ... instructions may be entirely obsolete rather than just missing a flag. The actual doc source may live in a separate cowprotocol/docs repo — filing here since the root cause is the CLI change in this repo, but the fix itself may belong there.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the local solver testing page linked in the issue and locate its source in the cowprotocol/docs repository. Compare the documented command with the autopilot --help output and inspect playground/docker-compose.fork.yml and its .env to determine whether the manual setup should be updated or replaced. Done means the instructions match a supported local-testing workflow.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker-compose, rust
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100