Skip to content

Commit

Permalink
Add documentation on autocompletion for command line tools
Browse files Browse the repository at this point in the history
  • Loading branch information
bouweandela authored and bari12 committed Apr 8, 2024
1 parent 2244780 commit c9fbe1a
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 0 deletions.
23 changes: 23 additions & 0 deletions docs/user/using_the_admin_client.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,29 @@ title: "Using the Admin Client"
Rucio provides a CLI for administrative tasks. The get methods can be executed
by any user, but the set methods require some admin privileges. See the
[rucio-admin help page](bin/rucio-admin.md).
The command line client for administrative tasks is called ``rucio-admin``.

## Getting help

To get an overview of the available ``rucio-admin`` subcommands and flags, run:

```bash
rucio-admin --help
```

## Enable command line autocompletion

If you would like to automatically complete ``rucio-admin`` commands, install
the [argcomplete](https://pypi.org/project/argcomplete/) package and run:

```bash
eval "$(register-python-argcomplete rucio-admin)"
```

Next, type ``rucio-admin `` (note the trailing space) and press the
<kbd>Tab</kbd> key to see all available options. To use the autocompletion
feature, type enough letters of a subcommand or flag to uniquely define it
and then press <kbd>Tab</kbd>.

## Account and identity methods

Expand Down
24 changes: 24 additions & 0 deletions docs/user/using_the_client.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,30 @@ title: Using the Client
---

Rucio provides several commands for the end-user. See [executables](bin/rucio.md).
The command line client is called ``rucio``.


## Getting help

To get an overview of the available ``rucio`` subcommands and flags, run:

```bash
rucio --help
```

## Enable command line autocompletion

If you would like to automatically complete ``rucio`` commands, install the
[argcomplete](https://pypi.org/project/argcomplete/) package and run:

```bash
eval "$(register-python-argcomplete rucio)"
```

Next, type ``rucio `` (note the trailing space) and press the <kbd>Tab</kbd>
key to see all available options. To use the autocompletion feature, type enough
letters of a subcommand or flag to uniquely define it and then press
<kbd>Tab</kbd>.

## Getting user information

Expand Down

0 comments on commit c9fbe1a

Please sign in to comment.