@@ -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.
-[`get`](#get) retrieves data from a specific cell.
-[`list`](#list) lists data available in PEP.
-[`query`](#query) provides information on the PEP environment.
...
...
@@ -52,6 +53,7 @@ General purpose:
Data storage and retrieval:
-[`get`](#get) retrieves data from a specific cell.
-[`list`](#list) lists data available in PEP.
## General flags
...
...
@@ -72,7 +74,23 @@ Other general flags exist, but are intended for use by developers of the PEP sys
# Commands supported by `pepcli`
## list
## `get`
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:
```
pepcli get -t <ticket file> -i <identifier> -o <output file>
```
The flags are:
-`-t` The ticket you stored with the `-T` flag of `pepcli list`
-`-i` The identifier you got from `pepcli list`
-`-o` The file to write the output to. `-` indicates stdout. This is the default.
-`-m` Also retrieve the metadata and write it to the given file. `-` indicates stdout. Default is to not retrieve metadata. If you do not know what you would need metadata for, then you probably don't need it.
## `list`
You can list data e.g. as follows:
```
pepcli list -C <column group> -P <participant group> -T <ticket out file>
...
...
@@ -95,7 +113,7 @@ 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
## `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:
...
...
@@ -108,20 +126,6 @@ The output will include all columns and column groups accessible to you, as well
- 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:
```
pepcli get -t <ticket file> -i <identifier> -o <output file>
```
The flags are:
-`-t` The ticket you stored with the `-T` flag of `pepcli list`
-`-i` The identifier you got from `pepcli list`
-`-o` The file to write the output to. `-` indicates stdout. This is the default.
-`-m` Also retrieve the metadata and write it to the given file. `-` indicates stdout. Default is to not retrieve metadata. If you do not know what you would need metadata for, then you probably don't need it.
