... | ... | @@ -15,6 +15,8 @@ Some commands have subcommands: |
|
|
pepcli [general flags] <COMMAND> <SUBCOMMAND> [subcommand flags] [parameters...]
|
|
|
```
|
|
|
|
|
|
The general flags are [documented separately](#general-flags). Commands are [listed alphabetically](#alphabetic-list-of-commands) and [documented in more detail](#commands-supported-by-pepcli). A [categorization by task](#commands-categorized-by-task) and/or audience is also available.
|
|
|
|
|
|
## Command line help
|
|
|
|
|
|
The `pepcli` application provides command line help if it is invoked without parameters, or with the `--help` switch:
|
... | ... | @@ -33,6 +35,20 @@ pepcli ama query --help # Output mentions the <em>--col |
|
|
pepcli ama query --column-group ShortPseudonyms # The completed command line
|
|
|
</pre>
|
|
|
|
|
|
## Alphabetic list of commands
|
|
|
|
|
|
The commands supported by `pepcli` are listed below. Follow hyperlinks to read more detailed documentation on each of the commands.
|
|
|
|
|
|
- [`query`](#query) provides information on the PEP environment.
|
|
|
|
|
|
## Commands categorized by task
|
|
|
|
|
|
The `pepcli` utility supports commands aimed at various tasks and/or types of users. This section categorizes commands accordingly.
|
|
|
|
|
|
General purpose:
|
|
|
|
|
|
- [`query`](#query) provides information on the PEP environment.
|
|
|
|
|
|
## General flags
|
|
|
|
|
|
Most of `pepcli`'s commands will connect to one or more of the PEP servers, and most server requests will require the user to be [enrolled](Access-control#enrollment). The utility's general flags can be used to indicate how to connect and enroll:
|
... | ... | @@ -49,18 +65,6 @@ pepcli --oauth-token /PATH/TO/OAuthToken.json --client-working-directory /PATH/T |
|
|
|
|
|
Other general flags exist, but are intended for use by developers of the PEP system. While mentioned in `pepcli`'s command line help, they are not further documented here.
|
|
|
|
|
|
## List of commands
|
|
|
|
|
|
The commands supported by `pepcli` are listed below. Follow hyperlinks to read more detailed documentation on each of the commands. A categorization [by task and/or audience](#by-task) is also available.
|
|
|
|
|
|
- [`query`](#query) provides information on the PEP environment.
|
|
|
|
|
|
## By task
|
|
|
|
|
|
General purpose:
|
|
|
|
|
|
- [`query`](#query) provides information on the PEP environment.
|
|
|
|
|
|
# Commands supported by `pepcli`
|
|
|
|
|
|
## query
|
... | ... | |