... | @@ -27,20 +27,21 @@ pepcli --help # Produces command line help |
... | @@ -27,20 +27,21 @@ pepcli --help # Produces command line help |
|
The `--help` switch is also supported by most (or all?) of `pepcli`'s commands and subcommands. This can be used to "drill down" through command line help to construct the appropriate command line, e.g. by sequentially invoking:
|
|
The `--help` switch is also supported by most (or all?) of `pepcli`'s commands and subcommands. This can be used to "drill down" through command line help to construct the appropriate command line, e.g. by sequentially invoking:
|
|
|
|
|
|
<pre>
|
|
<pre>
|
|
pepcli --help # Output includes the <em>ama</em> command
|
|
pepcli --help # Output includes the <em>ama</em> command, so we then issue:
|
|
pepcli ama --help # Output includes the <em>query</em> subcommand
|
|
pepcli ama --help # Output includes the <em>query</em> subcommand, so we then issue:
|
|
pepcli ama query --help # Output mentions the <em>--column-group</em> switch
|
|
pepcli ama query --help # Output mentions the <em>--column-group</em> switch, so we then issue:
|
|
pepcli ama query --column-group ShortPseudonyms # The completed command line
|
|
pepcli ama query --column-group ShortPseudonyms # The completed command line
|
|
</pre>
|
|
</pre>
|
|
|
|
|
|
## General flags
|
|
## General flags
|
|
|
|
|
|
Some of the general flags are the following:
|
|
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 provide details:
|
|
|
|
|
|
- `--oauth-token` You need this flag if you cannot use pepLogon. You will receive a token file that authenticates you to PEP. This flag takes the path to that file. After using this flag once you will remain authenticated for a day. So it's not necessary to pass this flag again. It's not a problem if you do pass it again, so when writing code that runs pepcli it's probably easiest to always pass this flag.
|
|
- `--client-working-directory` specifies a directory containing configuration files specifying how to connect to PEP's servers. If not specified, these configuration files are assumed to be located in the directory that contains the `pepcli` executable file.
|
|
- `--client-working-directory` pepcli comes with a set of configuration files. By default it looks for those files in the directory where the pepcli binary itself is located. This can be overridden with this flag.
|
|
- `--client-config-name` specifies the name of the main (client) configuration file. If not specified, the file is assumed to be named `ClientConfig.json`.
|
|
|
|
- `--oauth-token` specifies an OAuth token to be used for [enrollment](Access-control#enrollment), or the path to a file containing such an OAuth token. If not specified, the user is assumed to have been enrolled prior to `pepcli`'s invocation, e.g. by means of the `pepLogon` utility.
|
|
|
|
|
|
For brevity, these general flags will not be shown in the examples below. A full command looks like this:
|
|
For brevity, these general flags will not be mentioned in the documentation of individual commands, or in the examples below. But they may be included with any command issued to `pepcli`, e.g.:
|
|
|
|
|
|
```
|
|
```
|
|
pepcli --oauth-token /PATH/TO/OAuthToken.json --client-working-directory /PATH/TO/config-directory list -C \* -P \*
|
|
pepcli --oauth-token /PATH/TO/OAuthToken.json --client-working-directory /PATH/TO/config-directory list -C \* -P \*
|
... | | ... | |