Fix outdated CLI syntax in `using_the_client.md`
Open
@voetberg is already working on this.
Since Sep 1, 2026.
Discussion needed
enhancement
- Dominant language
- Python
- Stars
- 4
- Forks
- 71
- Avg merge
- 2d 1h
- Merged PRs (30d)
- 11
Description
Problem:
Documentation shows outdated CLI syntax that fails in Rucio 38.5.1:
rucio -a=root -S=OIDC -v whoami # Error: No such option: -a
Logs:
[root@rucio-server-8658d7545c-drzb5 tmp]# rucio --version
Unable to load schema module rucio_it_tools.rucio_it_sme_policy.schema from policy package, falling back to generic
rucio 38.5.1
[root@rucio-server-8658d7545c-drzb5 tmp]# rucio -a=root -S=OIDC -v whoami
Unable to load schema module rucio_it_tools.rucio_it_sme_policy.schema from policy package, falling back to generic
Usage: rucio [OPTIONS] COMMAND [ARGS]...
Try 'rucio -h' for help.
Error: No such option: -a
Question: How do we prevent docs from becoming outdated?
Potential Solutions:
- Automated CLI testing in CI - Run documented commands as part of CI
- Version-specific docs - Separate doc branches per major release
- Breaking change checklist - Require doc updates in PRs that change interfaces
- Executable examples - Use integration tests as living documentation
Immediate Action Needed:
- Fix current CLI examples to match v38.5.1 syntax
- Decide on long-term documentation maintenance strategy
Should we create issues for:
- Fixing the outdated CLI examples?
- Implementing automated doc validation in CI?
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.
Assessment
This issue has not been assessed yet.