nom¤
Usage:
nom [OPTIONS] COMMAND [ARGS]...
Options:
-h, --help Show this message and exit.
nom attachment¤
Usage:
nom attachment [OPTIONS] COMMAND [ARGS]...
Options:
-h, --help Show this message and exit.
nom attachment download¤
Download an attachment with the given RID to the specified location on disk.
Usage:
nom attachment download [OPTIONS]
Options:
-r, --rid TEXT [required]
-o, --output TEXT full path to write the attachment to (not just the
directory) [required]
--base-url TEXT Base URL of the Nominal API to hit. Useful for hitting
other clusters, e.g., staging for internal users.
[default: https://api.gov.nominal.io/api]
--token-path FILE Path to the yaml file containing the Nominal access token
for authenticating with the API [default:
/home/runner/.nominal.yml]
--token TEXT API Access token to use when creating the nominal client.
If provided, takes precedence over --token-path and
--base-url
--no-color If provided, don't color terminal log output
-v, --verbose Verbosity to use within the CLI. Pass -v to allow info-
level logs, or -vv for debug-level. [default: 0]
-h, --help Show this message and exit.
nom attachment get¤
Get an attachment by its RID
Usage:
nom attachment get [OPTIONS]
Options:
-r, --rid TEXT [required]
--base-url TEXT Base URL of the Nominal API to hit. Useful for hitting
other clusters, e.g., staging for internal users.
[default: https://api.gov.nominal.io/api]
--token-path FILE Path to the yaml file containing the Nominal access token
for authenticating with the API [default:
/home/runner/.nominal.yml]
--token TEXT API Access token to use when creating the nominal client.
If provided, takes precedence over --token-path and
--base-url
--no-color If provided, don't color terminal log output
-v, --verbose Verbosity to use within the CLI. Pass -v to allow info-
level logs, or -vv for debug-level. [default: 0]
-h, --help Show this message and exit.
nom attachment upload¤
Upload attachment from a local file with a given name and description and display the details of the newly created attachment to the user.
Usage:
nom attachment upload [OPTIONS]
Options:
-n, --name TEXT [required]
-f, --file TEXT path to the file to upload [required]
-d, --desc TEXT
--base-url TEXT Base URL of the Nominal API to hit. Useful for hitting
other clusters, e.g., staging for internal users.
[default: https://api.gov.nominal.io/api]
--token-path FILE Path to the yaml file containing the Nominal access token
for authenticating with the API [default:
/home/runner/.nominal.yml]
--token TEXT API Access token to use when creating the nominal client.
If provided, takes precedence over --token-path and
--base-url
--no-color If provided, don't color terminal log output
-v, --verbose Verbosity to use within the CLI. Pass -v to allow info-
level logs, or -vv for debug-level. [default: 0]
-h, --help Show this message and exit.
nom auth¤
Usage:
nom auth [OPTIONS] COMMAND [ARGS]...
Options:
-h, --help Show this message and exit.
nom auth set-token¤
Update the token for a given URL in the Nominal config file
Usage:
nom auth set-token [OPTIONS]
Options:
-u, --base-url TEXT [default: https://api.gov.nominal.io/api]
-t, --token TEXT access token, can be found in /sandbox on your Nominal
instance [required]
--no-color If provided, don't color terminal log output
-v, --verbose Verbosity to use within the CLI. Pass -v to allow info-
level logs, or -vv for debug-level. [default: 0]
-h, --help Show this message and exit.
nom dataset¤
Usage:
nom dataset [OPTIONS] COMMAND [ARGS]...
Options:
-h, --help Show this message and exit.
nom dataset get¤
Fetch a dataset by its RID
Usage:
nom dataset get [OPTIONS]
Options:
-r, --rid TEXT [required]
--base-url TEXT Base URL of the Nominal API to hit. Useful for hitting
other clusters, e.g., staging for internal users.
[default: https://api.gov.nominal.io/api]
--token-path FILE Path to the yaml file containing the Nominal access token
for authenticating with the API [default:
/home/runner/.nominal.yml]
--token TEXT API Access token to use when creating the nominal client.
If provided, takes precedence over --token-path and
--base-url
--no-color If provided, don't color terminal log output
-v, --verbose Verbosity to use within the CLI. Pass -v to allow info-
level logs, or -vv for debug-level. [default: 0]
-h, --help Show this message and exit.
nom dataset summarize¤
Summarize the dataset(s) by their schema (column names, types, and RIDs)
Usage:
nom dataset summarize [OPTIONS]
Options:
-r, --rid TEXT RID(s) of the dataset(s) to summarize
[required]
--show-rids / --no-show-rids If provided, show channel / dataset RIDs as
part of tabulated output [default: no-show-
rids]
-o, --output FILE If provided, a path to write the output to as
a file
-f, --format [csv|table] Output data format to represent the data as
[default: table]
--base-url TEXT Base URL of the Nominal API to hit. Useful for
hitting other clusters, e.g., staging for
internal users. [default:
https://api.gov.nominal.io/api]
--token-path FILE Path to the yaml file containing the Nominal
access token for authenticating with the API
[default: /home/runner/.nominal.yml]
--token TEXT API Access token to use when creating the
nominal client. If provided, takes precedence
over --token-path and --base-url
--no-color If provided, don't color terminal log output
-v, --verbose Verbosity to use within the CLI. Pass -v to
allow info-level logs, or -vv for debug-level.
[default: 0]
-h, --help Show this message and exit.
nom dataset upload-csv¤
Upload a local CSV file to Nominal, create and ingest the data into a dataset, and print the details of the newly created dataset to the user.
Usage:
nom dataset upload-csv [OPTIONS]
Options:
-n, --name TEXT [required]
-f, --file TEXT path to the CSV file to upload [required]
-t, --timestamp-column TEXT the primary timestamp column name
[required]
-T, --timestamp-type [iso_8601|epoch_days|epoch_hours|epoch_minutes|epoch_seconds|epoch_milliseconds|epoch_microseconds|epoch_nanoseconds]
interpretation the primary timestamp column
[required]
-d, --desc TEXT
--wait / --no-wait wait until the upload is complete [default:
wait]
--base-url TEXT Base URL of the Nominal API to hit. Useful
for hitting other clusters, e.g., staging
for internal users. [default:
https://api.gov.nominal.io/api]
--token-path FILE Path to the yaml file containing the Nominal
access token for authenticating with the API
[default: /home/runner/.nominal.yml]
--token TEXT API Access token to use when creating the
nominal client. If provided, takes
precedence over --token-path and --base-url
--no-color If provided, don't color terminal log output
-v, --verbose Verbosity to use within the CLI. Pass -v to
allow info-level logs, or -vv for debug-
level. [default: 0]
-h, --help Show this message and exit.
nom run¤
Usage:
nom run [OPTIONS] COMMAND [ARGS]...
Options:
-h, --help Show this message and exit.
nom run create¤
Create a new run
Usage:
nom run create [OPTIONS]
Options:
-n, --name TEXT [required]
-s, --start TEXT [required]
-e, --end TEXT [required]
-d, --desc TEXT
--property <TEXT TEXT>...
--label TEXT
--base-url TEXT Base URL of the Nominal API to hit. Useful for
hitting other clusters, e.g., staging for
internal users. [default:
https://api.gov.nominal.io/api]
--token-path FILE Path to the yaml file containing the Nominal
access token for authenticating with the API
[default: /home/runner/.nominal.yml]
--token TEXT API Access token to use when creating the nominal
client. If provided, takes precedence over
--token-path and --base-url
--no-color If provided, don't color terminal log output
-v, --verbose Verbosity to use within the CLI. Pass -v to allow
info-level logs, or -vv for debug-level.
[default: 0]
-h, --help Show this message and exit.
nom run get¤
Get a run by its RID
Usage:
nom run get [OPTIONS]
Options:
-r, --rid TEXT [required]
--base-url TEXT Base URL of the Nominal API to hit. Useful for hitting
other clusters, e.g., staging for internal users.
[default: https://api.gov.nominal.io/api]
--token-path FILE Path to the yaml file containing the Nominal access token
for authenticating with the API [default:
/home/runner/.nominal.yml]
--token TEXT API Access token to use when creating the nominal client.
If provided, takes precedence over --token-path and
--base-url
--no-color If provided, don't color terminal log output
-v, --verbose Verbosity to use within the CLI. Pass -v to allow info-
level logs, or -vv for debug-level. [default: 0]
-h, --help Show this message and exit.