Update Using pepcli authored by Kai van Lopik's avatar Kai van Lopik
...@@ -10,13 +10,12 @@ The `pepcli` utility must be invoked from a command line, with parameters tellin ...@@ -10,13 +10,12 @@ The `pepcli` utility must be invoked from a command line, with parameters tellin
pepcli [general flags] <COMMAND> [command flags] [parameters...] pepcli [general flags] <COMMAND> [command flags] [parameters...]
``` ```
Some commands have subcommands: The various [commands are documented](#commands) in some detail on this page. The general flags are [documented separately](#general-flags). Some commands have subcommands:
``` ```
pepcli [general flags] <COMMAND> <SUBCOMMAND> [subcommand flags] [parameters...] 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 ## Command line help
The `pepcli` application provides command line help if it is invoked without parameters, or with the `--help` switch: The `pepcli` application provides command line help if it is invoked without parameters, or with the `--help` switch:
...@@ -35,24 +34,25 @@ pepcli ama query --help # Output mentions the <em>--col ...@@ -35,24 +34,25 @@ pepcli ama query --help # Output mentions the <em>--col
pepcli ama query --column-group ShortPseudonyms # The completed command line pepcli ama query --column-group ShortPseudonyms # The completed command line
</pre> </pre>
## Alphabetic list of commands ## General flags
The commands supported by `pepcli` are listed below. Follow hyperlinks to read more detailed documentation on each of the commands. 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:
- [`ama`](#ama) provides subcommands to perform administrative tasks related to the Access Manager service. - `--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 containing the `pepcli` executable file.
- [`ama cgar`](ama-cgar) can be used to manage the type(s) of access that access groups have to column groups. - `--client-config-name` specifies the name of the main (client) configuration file. If not specified, the file is assumed to be named `ClientConfig.json`.
- [`ama column`](ama-column) can be used to create and remove columns, and to group and un-group them. - `--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.
- [`ama columnGroup`](ama-columngroup) can be used to create and remove columns, and to group and un-group them.
- [`ama query`](ama-query) summarizes the current data structure and access rules. 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.:
- [`get`](#get) retrieves data from a specific cell.
- [`list`](#list) lists data available in PEP. ```
- [`pull`](#pull) stores a data set in files on your local machine. pepcli --oauth-token /PATH/TO/OAuthToken.json --client-working-directory /PATH/TO/config-directory list -C \* -P \*
- [`query`](#query) provides information on the PEP environment. ```
- [`store`](#store) stores data in a specific cell.
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.
## Commands categorized by task # Commands
The `pepcli` utility supports commands aimed at various tasks and/or types of users. This section categorizes commands accordingly. The `pepcli` utility supports commands for various tasks, aimed at different types of users:
General purpose: General purpose:
...@@ -75,24 +75,6 @@ Administrative tasks: ...@@ -75,24 +75,6 @@ Administrative tasks:
- For users enrolled as an `Access Administrator`: - For users enrolled as an `Access Administrator`:
- [`ama cgar`](ama-cgar) can be used to manage the type(s) of access that access groups have to column groups. - [`ama cgar`](ama-cgar) can be used to manage the type(s) of access that access groups have to column groups.
## 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:
- `--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 containing the `pepcli` executable file.
- `--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 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 \*
```
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.
# Commands supported by `pepcli`
## `ama` ## `ama`
The `ama` command's various sub-commands can be used to perform administrative tasks. While `ama` is short for "Access Manager Administration", it should be noted that `ama` provides subcommands for both the `Access Administrator` and `Data Administrator` roles. Users must be enrolled for the role appropriate for the subcommand they're invoking. The `ama` command's various sub-commands can be used to perform administrative tasks. While `ama` is short for "Access Manager Administration", it should be noted that `ama` provides subcommands for both the `Access Administrator` and `Data Administrator` roles. Users must be enrolled for the role appropriate for the subcommand they're invoking.
... ...
......