Is there a full documentaion for pulp-cli available?

Problem:

I’m new to pulp and trying to understand how to manage it via cli. I.e. it’s not clear what --staff option gives to a user and what it’s needed for.

Expected outcome:

It would be nice to have full cli documentation with every command explained

Pulpcore version:
3.80.0

Pulp plugins installed and their versions:
Pulp3 Command Line Interface, Version 0.32.3
Plugin Versions:
common: 0.32.3

Operating system - distribution and version:
MacOS

1 Like

Every pulp CLI subcommand knows the --help option. To the best of my knowledge, what is not documented there is not documented.

1 Like

Yeah, I know about --help, this is the first thing I used it. But in some cases it’s not clear what this option for, like --staff. I had to search the whole documentation just to found

“Having disabled the token authentication, only users with staff privileges (i.e., administrators) are allowed to push content to the registry.”

@DenisBY We have some docs on the CLI: Using the CLI - Pulp Project, but mainly it’s through each plugin’s documentation that shows off the available commands. You will find that we try to maintain the same command structure across plugins so that the syntax between plugins feels familiar.

As for your second part about the --staff option, unfortunately that is not correct and we really should fix the documentation on it (and remove the option from the API & CLI). Staff comes from the default Django code, but the Pulp project doesn’t actually use it. We just have superusers (admins) and everyone else whose permissions are managed by the RBAC system. We also don’t use the --active flag for users either.

1 Like