@@ -39,6 +39,7 @@ pepcli ama query --column-group ShortPseudonyms # The completed command line
The commands supported by `pepcli` are listed below. Follow hyperlinks to read more detailed documentation on each of the commands.
-[`list`](#list) lists data stored in PEP.
-[`query`](#query) provides information on the PEP environment.
## Commands categorized by task
...
...
@@ -49,6 +50,10 @@ General purpose:
-[`query`](#query) provides information on the PEP environment.
Data storage and retrieval:
-[`list`](#list) lists data stored in PEP.
## 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:
...
...
@@ -67,20 +72,7 @@ Other general flags exist, but are intended for use by developers of the PEP sys
# Commands supported by `pepcli`
## query
Use the `pepcli query` command to query the system. It currently only supports a single sub-command, which lists the columns accessible to you:
```
pepcli query column-access
```
The output will include all columns and column groups accessible to you, as well as whether you have read and/or write access. Note that such access depends on the access group for which you are enrolled. Enroll for a specific access group:
- either by means of a prior call to `pepLogon`,
- or by passing an appropriate [OAuth token](#general-flags) to `pepcli`.
## List data
## list
You can list data e.g. as follows:
```
pepcli list -C <column group> -P <participant group> -T <ticket out file>
...
...
@@ -103,6 +95,19 @@ Important flags are:
Note: Shells use `*` for globbing. We do not want this behaviour, so make sure you escape it with a backslash or double quotes when invoking pepcli from e.g. bash.
## query
Use the `pepcli query` command to query the system. It currently only supports a single sub-command, which lists the columns accessible to you:
```
pepcli query column-access
```
The output will include all columns and column groups accessible to you, as well as whether you have read and/or write access. Note that such access depends on the access group for which you are enrolled. Enroll for a specific access group:
- either by means of a prior call to `pepLogon`,
- or by [passing an appropriate OAuth token](#general-flags) to `pepcli`.
## Get specific entries
After you have done a list, depending on whether data was inlined or not, you have IDs for data entries. You can retrieve the data as follows:
