Skip to content

Fix outdated CLI syntax in using_the_client.md #694

@mgajek-cern

Description

@mgajek-cern

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

```bash
rucio -a=\<rucio_account_name\> -S=OIDC -v whoami
```

ff.

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:

  1. Automated CLI testing in CI - Run documented commands as part of CI
  2. Version-specific docs - Separate doc branches per major release
  3. Breaking change checklist - Require doc updates in PRs that change interfaces
  4. 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:

  1. Fixing the outdated CLI examples?
  2. Implementing automated doc validation in CI?

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions