CLI Option Values
This page lists command option values that are selected from a bounded set. Free-form names, paths, URLs, reasons, SQL text, timestamps, and environment variable names are documented in the CLI Manual instead.
Control Output Format Values
Used by --format on most control-plane commands and by --output-format when
--format is already used for a data or source format.
| Value | Description |
|---|---|
text | Human-oriented terminal output. Layout can change between releases. |
json | Stable machine-readable response envelope for automation. |
Dataset Data Format Values
Used by dataset data --format and dataset export --format.
| Value | Description |
|---|---|
arrow | Arrow IPC output for Arrow-native consumers. Requires --to because binary output is written to a file. |
parquet | Parquet dataset export. Requires --to because binary output is written to a file. |
csv | Comma-separated text rows. This is the only format that can stream to stdout. |
json | Newline-delimited JSON rows. Requires --to; internally this maps to the NDJSON export path. |
Dataset Table Format Values
Used by ingest dataset table --format and ingest dataset from-datafile --format.
| Value | Description |
|---|---|
csv | CSV table source. |
xlsx | Excel workbook source. Use --sheet when the workbook has multiple relevant sheets. |
json | JSON table source. Pair with --json-format when automatic detection is not enough. |
arrow | Arrow IPC table source. |
parquet | Parquet table source. |
JSON Data Format Values
Used by dataset table parsing option --json-format.
| Value | Description |
|---|---|
auto | Let the ingest workflow infer the JSON shape. |
array | Treat the source as a JSON array of records. |
newline-delimited | Treat the source as newline-delimited JSON records. |
unstructured | Treat the source as unstructured JSON rather than a rectangular record table. |
Boolean Option Values
Used by explicit boolean-valued options such as dataset table parsing option
--header.
| Value | Description |
|---|---|
true | Enables the option. |
false | Disables the option. |
Asset Type Values
Used by asset selectors such as asset --type and tag selector
--asset-type.
| Value | Description |
|---|---|
dataset | Dataset asset. |
file | Managed datafile asset. |
PostgreSQL SSL Mode Values
Used by datastore maintenance option --sslmode. The value is passed through
to PostgreSQL/libpq connection handling.
| Value | Description |
|---|---|
disable | Do not use SSL/TLS. |
allow | Try a non-SSL connection first, then SSL if needed. |
prefer | Try SSL first, then non-SSL if needed. |
require | Require SSL/TLS without certificate authority verification. |
verify-ca | Require SSL/TLS and verify the server certificate authority. |
verify-full | Require SSL/TLS, verify the certificate authority, and verify the server hostname. |
Tag Target Values
Used by tag get --target and tag set --target.
| Value | Description |
|---|---|
domain | Tags a semantic domain selected by --name. |
study | Tags a study selected by --name. |
variable | Tags a variable selected by --domain and --name. |
entity | Tags an entity definition selected by --domain and --name. |
entity-relation | Tags an entity relation definition selected by --domain and --name. |
asset | Tags an asset selected by --name; --asset-type can disambiguate dataset and file assets. Protocol automation can also use an asset ref. |
asset-version | Tags an asset version selected by --name, --version, and optional --asset-type. Protocol automation can also use an asset ref plus version. |
datafile | Tags a managed datafile asset selected by --name. Protocol automation can also use a datafile ref. |
datafile-version | Tags a managed datafile version selected by --name and --version. Protocol automation can also use a datafile ref plus version. |
dataset | Tags a dataset asset selected by --name. Protocol automation can also use a dataset ref. |
dataset-version | Tags a dataset version selected by --name and --version. Protocol automation can also use a dataset ref plus version. |
Protocol automation can also target semantic domain, study, variable,
entity, and entity-relation tag targets by their public refs. Data catalog
tag targets support asset, datafile, and dataset refs on the implemented
automation and daemon-backed protocol paths; missing refs fail as not found or
validation errors rather than unsupported selector errors.
Shell Values
Used by completion <shell>.
| Value | Description |
|---|---|
bash | Generate Bash completion. |
elvish | Generate Elvish completion. |
fish | Generate Fish completion. |
powershell | Generate PowerShell completion. |
zsh | Generate Zsh completion. |
Study Type Values
Used by study add --study-type. The CLI accepts either the integer id or the
symbolic name and normalizes the value to the integer id before sending a stable
protocol request. Stable protocol and app-layer requests still use the integer
id. These values come from the seeded study_types reference table.
| Value | Name | Description |
|---|---|---|
1 | HDSS | Health and Demographic Surveillance System |
2 | COHORT | Cohort Study |
3 | SURVEY | Cross-sectional Study |
4 | PANEL | Longitudinal/Panel Survey |
5 | CASE_CONTROL | Case-Control Study |
6 | RCT | Randomized Controlled Trial |
7 | QUASI_EXPERIMENTAL | Quasi-experimental Study |
8 | NATURAL_EXPERIMENT | Natural Experiment |
10 | LAB_EXPERIMENT | Laboratory Study |
11 | QUALITATIVE_INTERVIEW | In-depth or Key Informant Interviews |
12 | FOCUS_GROUP | Focus Group Discussion |
13 | ETHNOGRAPHY | Ethnographic Study |
14 | PARTICIPATORY | Participatory Action Research |
15 | CASE_STUDY | Case Study |
16 | MIXED_METHODS | Mixed Methods Study |
17 | SECONDARY_ANALYSIS | Secondary Data Analysis |
18 | DESK_REVIEW | Desk or Literature Review |
19 | TIME_MOTION | Time and Motion Study |
20 | DIARY | Diary Study |
21 | LONGITUDINAL_OBSERVATION | Longitudinal Observational Study |
22 | SIMULATION | Simulation Study |
23 | AGENT_BASED_MODEL | Agent-based Modelling |
24 | STATISTICAL_MODEL | Statistical Modelling |
25 | SYSTEM_DYNAMICS | Biological system modelling |
26 | GENOMICS | Genomics Study |
27 | MULTIOMICS | Multi-omics Study, such as proteomics or metabolomics |
28 | BIOBANK | Biobank-based Study |
29 | PHARMACOGENOMICS | Pharmacogenomics Study |
Variable Value Type Values
Used by variable add --value-type and variable update --value-type. These
values come from the seeded value_types reference table.
| Value | Description |
|---|---|
xsd:integer | Integer value. |
xsd:float | Floating-point value. |
xsd:string | String value. |
xsd:date | ISO date value, yyyy-mm-dd. |
xsd:dateTime | ISO datetime value, yyyy-mm-ddTHH:mm:ss.sss. |
xsd:time | ISO time value, HH:mm:ss.sss. |
enumeration | Categorical variable represented by a governed vocabulary with integer values and string codes. |
multiresponse | Multi-response categorical variable with multiple values, stored as an array of integers. |
Variable Keyrole Values
Used by variable add --keyrole and variable update --keyrole.
| Value | Description |
|---|---|
none | Ordinary variable with no row identity role. |
record | Record key variable for identifying rows within a dataset. |
external | External identifier variable that maps source rows to study-specific entity or relation identifiers. |
SQL Source Flavour Values
Used by ingest dataset from-sql --flavour.
| Value | Description |
|---|---|
duckdb | Client-side read from --duckdb-path. |
sqlite | Client-side read from --sqlite-path. |
postgresql | Client or Trusted read from --source-endpoint postgresql://HOST:PORT/DATABASE. |
mssql | Client or Trusted read from --source-endpoint mssql://HOST:PORT/DATABASE. |
Remote sources require explicit --acquisition client or trusted and typed
credentials through --source-auth postgresql/mssql with
--source-material-stdin, or an entitled --shared-source for Trusted
acquisition. Credentials and connection-string options are forbidden in the
endpoint. See the SQL source contract.
Datafile Format Values
Used by ingest datafile --format. This option stores an EDAM format value for
the managed datafile. It is not a closed enum: explicit EDAM identifiers or MIME
types are accepted. The CLI also normalizes the common shortcuts below.
| Value | Stored format | Description |
|---|---|---|
csv | EDAM:format_3752 | Shortcut for CSV datafiles. |
text/csv | EDAM:format_3752 | MIME-type shortcut for CSV datafiles. |
json | EDAM:format_3464 | Shortcut for JSON datafiles. |
application/json | EDAM:format_3464 | MIME-type shortcut for JSON datafiles. |
<EDAM-or-MIME> | As supplied | Any other non-empty EDAM format identifier or MIME type is recorded as supplied. |
Asset Version Selector Values
Used by ordinary asset, datafile, and dataset version selectors. When these options are optional and omitted, commands normally select the latest version.
| Value | Description |
|---|---|
latest | Select the latest version of the asset. |
<semver> | Select a specific semantic version, such as 1.0.0. |
Delete Version Selector Values
Used by datafile delete --version and dataset delete --version.
| Value | Description |
|---|---|
latest | Select the latest version of the asset. |
all | Select every version of the asset for whole-asset deletion. |
<semver> | Select a specific semantic version, such as 1.0.0. |
Dataset Withdrawal Version Values
Used by dataset withdraw --version.
| Value | Description |
|---|---|
<semver> | Select a specific semantic version, such as 1.0.0. latest is intentionally rejected for withdrawals. |