nom¤
Usage:
nom [OPTIONS] COMMAND [ARGS]...
Options:
--version Show the version and exit.
-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]
--profile TEXT If provided, use the given named config profile for
instantiating a Nominal Client. This is the
preferred mechanism for instantiating a client
today-- see `nom config profile add` to create a
configuration profile. If provided, takes
precedence over --token, --token-path, and --base-
url. [required]
--trust-store-path FILE Path to a trust store CA root file to initiate SSL
connections. If not provided, defaults to certifi's
trust store.
--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]
--profile TEXT If provided, use the given named config profile for
instantiating a Nominal Client. This is the
preferred mechanism for instantiating a client
today-- see `nom config profile add` to create a
configuration profile. If provided, takes
precedence over --token, --token-path, and --base-
url. [required]
--trust-store-path FILE Path to a trust store CA root file to initiate SSL
connections. If not provided, defaults to certifi's
trust store.
--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, --description TEXT description of the attachment
--profile TEXT If provided, use the given named config profile for
instantiating a Nominal Client. This is the
preferred mechanism for instantiating a client
today-- see `nom config profile add` to create a
configuration profile. If provided, takes
precedence over --token, --token-path, and --base-
url. [required]
--trust-store-path FILE Path to a trust store CA root file to initiate SSL
connections. If not provided, defaults to certifi's
trust store.
--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 config¤
Usage:
nom config [OPTIONS] COMMAND [ARGS]...
Options:
-h, --help Show this message and exit.
nom config migrate¤
Interactively migrate deprecated config at ~/.nominal.yml to new profile-based config at ~/.config/nominal/config.yml
Usage:
nom config migrate [OPTIONS]
Options:
-h, --help Show this message and exit.
nom config profile¤
Usage:
nom config profile [OPTIONS] COMMAND [ARGS]...
Options:
-h, --help Show this message and exit.
nom config profile add¤
Add or update a profile to your Nominal config
Usage:
nom config profile add [OPTIONS] PROFILE
Options:
-t, --token TEXT bearer token or api key [required]
-u, --base-url TEXT [default: https://api.gov.nominal.io/api]
-w, --workspace-rid TEXT workspace RID [optional]
--validate / --no-validate Validate authentication parameters [default:
validate]
--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 config profile list¤
List the profiles in your Nominal config
Usage:
nom config profile list [OPTIONS]
Options:
--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 config profile remove¤
Remove a profile from your Nominal config
Usage:
nom config profile remove [OPTIONS] PROFILE
Options:
--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 container¤
Work with containerized extractors and the container images they run.
An extractor carries identity; its execution contract (inputs, parameters, output format, timestamp defaults) lives on the container images registered against it, exactly one of which is active.
Usage:
nom container [OPTIONS] COMMAND [ARGS]...
Options:
-h, --help Show this message and exit.
nom container extractor¤
Create and manage containerized extractors and their image lifecycle
Usage:
nom container extractor [OPTIONS] COMMAND [ARGS]...
Options:
-h, --help Show this message and exit.
nom container extractor archive¤
Archive a containerized extractor
Usage:
nom container extractor archive [OPTIONS]
Options:
-r, --rid TEXT [required]
--profile TEXT If provided, use the given named config profile for
instantiating a Nominal Client. This is the
preferred mechanism for instantiating a client
today-- see `nom config profile add` to create a
configuration profile. If provided, takes
precedence over --token, --token-path, and --base-
url. [required]
--trust-store-path FILE Path to a trust store CA root file to initiate SSL
connections. If not provided, defaults to certifi's
trust store.
--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 container extractor create¤
Create a containerized extractor.
A newly created extractor has no container image: register one with register-image and
activate it with set-active-image before ingesting.
Usage:
nom container extractor create [OPTIONS]
Options:
-n, --name TEXT [required]
-d, --description TEXT description of the extractor
--profile TEXT If provided, use the given named config profile for
instantiating a Nominal Client. This is the
preferred mechanism for instantiating a client
today-- see `nom config profile add` to create a
configuration profile. If provided, takes
precedence over --token, --token-path, and --base-
url. [required]
--trust-store-path FILE Path to a trust store CA root file to initiate SSL
connections. If not provided, defaults to certifi's
trust store.
--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 container extractor get¤
Get a containerized extractor by its RID
Usage:
nom container extractor get [OPTIONS]
Options:
-r, --rid TEXT [required]
--profile TEXT If provided, use the given named config profile for
instantiating a Nominal Client. This is the
preferred mechanism for instantiating a client
today-- see `nom config profile add` to create a
configuration profile. If provided, takes
precedence over --token, --token-path, and --base-
url. [required]
--trust-store-path FILE Path to a trust store CA root file to initiate SSL
connections. If not provided, defaults to certifi's
trust store.
--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 container extractor register-image¤
Upload a docker save tarball and register it as a container image for an extractor.
Prints the resulting container image RID on stdout (status messages go to stderr), suitable for capturing in CI:
IMAGE_RID=$(nom container extractor register-image -r "$EXTRACTOR_RID" \
-f image.tar -t $(git rev-parse --short HEAD) -c extractor-config.json)
nom container extractor set-active-image -r "$EXTRACTOR_RID" -i "$IMAGE_RID"
The registered image starts PENDING and must be activated with set-active-image once READY.
Usage:
nom container extractor register-image [OPTIONS]
Options:
-r, --rid TEXT RID of the extractor to register the image
against [required]
-f, --file FILE path to the uncompressed `docker save`
tarball to upload [required]
-t, --tag TEXT tag to register the image under, typically a
git short SHA
-c, --config FILE path to a JSON file describing the image's
execution contract: `inputs` and
`parameters` (lists of objects with
snake_case FileExtractionInput /
FileExtractionParameter fields), and
optionally `tag`,
`default_timestamp_column`,
`default_timestamp_type`, and
`output_format`. Typically a per-package
config checked into the repo. Values
supplied via flags override fields in the
JSON.
--timestamp-column TEXT the column containing timestamp data in the
extractor's output files
--timestamp-type [iso_8601|epoch_picoseconds|epoch_nanoseconds|epoch_microseconds|epoch_milliseconds|epoch_seconds|epoch_minutes|epoch_hours|epoch_days]
interpretation of the timestamp column in
the extractor's output files
--output-format [avro_stream|csv|manifest|parquet]
file format the extractor writes [default:
parquet]
--wait / --no-wait wait until the image is READY [default:
wait]
--profile TEXT If provided, use the given named config
profile for instantiating a Nominal Client.
This is the preferred mechanism for
instantiating a client today-- see `nom
config profile add` to create a
configuration profile. If provided, takes
precedence over --token, --token-path, and
--base-url. [required]
--trust-store-path FILE Path to a trust store CA root file to
initiate SSL connections. If not provided,
defaults to certifi's trust store.
--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 container extractor search¤
Search for containerized extractors (filters are ANDed together)
Usage:
nom container extractor search [OPTIONS]
Options:
--include-archived include archived extractors in the results
--file-extension TEXT only include extractors whose active image accepts
files with this suffix (e.g. "csv" -- no leading
dot)
--workspace TEXT workspace RID to search [default: the profile's
workspace]
-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]
--profile TEXT If provided, use the given named config profile
for instantiating a Nominal Client. This is the
preferred mechanism for instantiating a client
today-- see `nom config profile add` to create a
configuration profile. If provided, takes
precedence over --token, --token-path, and --base-
url. [required]
--trust-store-path FILE Path to a trust store CA root file to initiate SSL
connections. If not provided, defaults to
certifi's trust store.
--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 container extractor set-active-image¤
Select the container image an extractor runs when ingesting
Usage:
nom container extractor set-active-image [OPTIONS]
Options:
-r, --rid TEXT RID of the extractor [required]
-i, --image-rid TEXT RID of the registered image to activate [required]
--wait / --no-wait wait until the image is READY before activating
(with --no-wait, a non-READY image errors)
[default: wait]
--profile TEXT If provided, use the given named config profile for
instantiating a Nominal Client. This is the
preferred mechanism for instantiating a client
today-- see `nom config profile add` to create a
configuration profile. If provided, takes
precedence over --token, --token-path, and --base-
url. [required]
--trust-store-path FILE Path to a trust store CA root file to initiate SSL
connections. If not provided, defaults to certifi's
trust store.
--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 container extractor unarchive¤
Unarchive a containerized extractor
Usage:
nom container extractor unarchive [OPTIONS]
Options:
-r, --rid TEXT [required]
--profile TEXT If provided, use the given named config profile for
instantiating a Nominal Client. This is the
preferred mechanism for instantiating a client
today-- see `nom config profile add` to create a
configuration profile. If provided, takes
precedence over --token, --token-path, and --base-
url. [required]
--trust-store-path FILE Path to a trust store CA root file to initiate SSL
connections. If not provided, defaults to certifi's
trust store.
--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 container extractor update¤
Update mutable fields of a containerized extractor (only the flags you pass are sent)
Usage:
nom container extractor update [OPTIONS]
Options:
-r, --rid TEXT [required]
-n, --name TEXT replace the extractor's name
-d, --description TEXT replace the extractor's description
--profile TEXT If provided, use the given named config profile for
instantiating a Nominal Client. This is the
preferred mechanism for instantiating a client
today-- see `nom config profile add` to create a
configuration profile. If provided, takes
precedence over --token, --token-path, and --base-
url. [required]
--trust-store-path FILE Path to a trust store CA root file to initiate SSL
connections. If not provided, defaults to certifi's
trust store.
--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 container extractor validate-config¤
Validate a register-image config JSON without contacting Nominal.
Runs the exact validation register-image performs before uploading, so it can lint a
checked-in config in CI without credentials. Values that must be supplied via flags at
register time (e.g. a missing tag) are reported as notes, not errors.
Usage:
nom container extractor validate-config [OPTIONS] CONFIG_PATH
Options:
--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 container image¤
Inspect and manage container images in Nominal's registry
Usage:
nom container image [OPTIONS] COMMAND [ARGS]...
Options:
-h, --help Show this message and exit.
nom container image delete¤
Delete a container image (fails if an extractor still has it as its active image)
Usage:
nom container image delete [OPTIONS]
Options:
-r, --rid TEXT [required]
--yes skip the confirmation prompt
--profile TEXT If provided, use the given named config profile for
instantiating a Nominal Client. This is the
preferred mechanism for instantiating a client
today-- see `nom config profile add` to create a
configuration profile. If provided, takes
precedence over --token, --token-path, and --base-
url. [required]
--trust-store-path FILE Path to a trust store CA root file to initiate SSL
connections. If not provided, defaults to certifi's
trust store.
--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 container image get¤
Get a container image by its RID
Usage:
nom container image get [OPTIONS]
Options:
-r, --rid TEXT [required]
--profile TEXT If provided, use the given named config profile for
instantiating a Nominal Client. This is the
preferred mechanism for instantiating a client
today-- see `nom config profile add` to create a
configuration profile. If provided, takes
precedence over --token, --token-path, and --base-
url. [required]
--trust-store-path FILE Path to a trust store CA root file to initiate SSL
connections. If not provided, defaults to certifi's
trust store.
--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 container image search¤
Search for container images, filtering by tag, status, and/or extractor (filters are ANDed together)
Usage:
nom container image search [OPTIONS]
Options:
-t, --tag TEXT filter to images with this exact tag
--status [pending|ready|failed]
filter to images with this lifecycle status
-e, --extractor TEXT filter to images registered against this
extractor RID
--workspace TEXT workspace RID to search [default: the
profile's workspace]
-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]
--profile TEXT If provided, use the given named config
profile for instantiating a Nominal Client.
This is the preferred mechanism for
instantiating a client today-- see `nom
config profile add` to create a
configuration profile. If provided, takes
precedence over --token, --token-path, and
--base-url. [required]
--trust-store-path FILE Path to a trust store CA root file to
initiate SSL connections. If not provided,
defaults to certifi's trust store.
--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]
--profile TEXT If provided, use the given named config profile for
instantiating a Nominal Client. This is the
preferred mechanism for instantiating a client
today-- see `nom config profile add` to create a
configuration profile. If provided, takes
precedence over --token, --token-path, and --base-
url. [required]
--trust-store-path FILE Path to a trust store CA root file to initiate SSL
connections. If not provided, defaults to certifi's
trust store.
--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]
--profile TEXT If provided, use the given named config
profile for instantiating a Nominal Client.
This is the preferred mechanism for
instantiating a client today-- see `nom config
profile add` to create a configuration
profile. If provided, takes precedence over
--token, --token-path, and --base-url.
[required]
--trust-store-path FILE Path to a trust store CA root file to initiate
SSL connections. If not provided, defaults to
certifi's trust store.
--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, --description TEXT description of the dataset
--channel-name-delimiter TEXT the character used to delimit the hierarchy
in the channel name [default: .]
--wait / --no-wait wait until the upload is complete [default:
wait]
--profile TEXT If provided, use the given named config
profile for instantiating a Nominal Client.
This is the preferred mechanism for
instantiating a client today-- see `nom
config profile add` to create a
configuration profile. If provided, takes
precedence over --token, --token-path, and
--base-url. [required]
--trust-store-path FILE Path to a trust store CA root file to
initiate SSL connections. If not provided,
defaults to certifi's trust store.
--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 download¤
Browse assets, pick a dataset, filter channels by exact name, and download.
Usage:
nom download [OPTIONS]
Options:
--channels-per-request INTEGER RANGE
Number of channels to request at a time. For
requesting a small number of channels,
setting this value low helps parallelize
downloads. [default: 10; x>=1]
--points-per-file INTEGER RANGE
Number of points to put in each written
file. [default: 25000000; x>=1]
--format [csv|parquet] [default: parquet]
--profile TEXT If provided, use the given named config
profile for instantiating a Nominal Client.
This is the preferred mechanism for
instantiating a client today-- see `nom
config profile add` to create a
configuration profile. If provided, takes
precedence over --token, --token-path, and
--base-url. [required]
--trust-store-path FILE Path to a trust store CA root file to
initiate SSL connections. If not provided,
defaults to certifi's trust store.
--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 migrate¤
Commands to migrate resources between Nominal tenants.
Usage:
nom migrate [OPTIONS] COMMAND [ARGS]...
Options:
-h, --help Show this message and exit.
nom migrate copy¤
Copy resources from a source tenant to a destination tenant.
Usage:
nom migrate copy [OPTIONS]
Options:
--destination-profile TEXT If provided, use the given named config profile
for instantiating a Nominal Client for the
destination tenant. This is the preferred
mechanism for instantiating a client today--
see `nom config profile add` to create a
configuration profile. If provided, takes
precedence over --token, --token-path, and
--base-url. [required]
--source-profile TEXT If provided, use the given named config profile
for instantiating a Nominal Client for the
source tenant. This is the preferred mechanism
for instantiating a client today-- see `nom
config profile add` to create a configuration
profile. If provided, takes precedence over
--token, --token-path, and --base-url.
[required]
--trust-store-path FILE Path to a trust store CA root file to initiate
SSL connections. If not provided, defaults to
certifi's trust store.
--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]
--config FILE Path to the migration config YAML file.
[required]
--migration-state-path PATH Path to load/save migration state JSON for
resumable migrations. Defaults to
'migration_state.json'.
--max-workers INTEGER RANGE Maximum number of top-level asset/template
migrations to run concurrently. [default: 1;
x>=1]
--dry-run Log what would be created without writing
anything to the destination tenant or state
file.
-h, --help Show this message and exit.
nom migrate prep¤
Count in-scope and out-of-scope resources and generate a migration config.
Usage:
nom migrate prep [OPTIONS]
Options:
--profile TEXT If provided, use the given named config profile for
instantiating a Nominal Client. This is the
preferred mechanism for instantiating a client
today-- see `nom config profile add` to create a
configuration profile. If provided, takes
precedence over --token, --token-path, and --base-
url. [required]
--trust-store-path FILE Path to a trust store CA root file to initiate SSL
connections. If not provided, defaults to certifi's
trust store.
--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]
--name TEXT Name for the migration (written into the generated
config file). [required]
--output FILE Path where the generated migration config YAML will
be written. [required]
-h, --help Show this message and exit.
nom migrate summary¤
Summarize a migration as a markdown table. Fully offline: no profiles or tokens required.
Usage:
nom migrate summary [OPTIONS]
Options:
--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]
--from-config FILE Migration config YAML for an offline size check. Repeat
the flag to summarize several configs.
--from-log FILE Captured 'nom migrate copy --dry-run' log to tally
would-create lines from.
--from-state FILE Migration-state JSON to count created resources from.
--output FILE File to append the markdown summary to, e.g.
$GITHUB_STEP_SUMMARY.
-h, --help Show this message and exit.
nom mis¤
This CLI processes an MIS and turns it into unit assignments and channel descriptions on a dataset. MIS must be a CSV with the following columns: Channel, Description, UCUM Unit
Example:
Channel, Description, UCUM Unit
RPM, Engine RPM, rpm
ECT1, Engine Coolant Temperature Main, Cel
Usage:
nom mis [OPTIONS] COMMAND [ARGS]...
Options:
-h, --help Show this message and exit.
nom mis list-units¤
List all available units in Nominal.
Usage:
nom mis list-units [OPTIONS]
Options:
-o, --output FILE If provided, write the output to a file.
-f, --format [table|csv] The format to represent the data as [default:
table]
--profile TEXT If provided, use the given named config profile
for instantiating a Nominal Client. This is the
preferred mechanism for instantiating a client
today-- see `nom config profile add` to create a
configuration profile. If provided, takes
precedence over --token, --token-path, and --base-
url. [required]
--trust-store-path FILE Path to a trust store CA root file to initiate SSL
connections. If not provided, defaults to
certifi's trust store.
--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 mis process¤
Processes an MIS file and updates channel descriptions and units.
Usage:
nom mis process [OPTIONS] MIS_PATH
Options:
--dataset-rid TEXT The RID of the dataset to update. [required]
--sheet TEXT The sheet to use in the Excel file if parsing
direct from Excel. Only needed if there are
multiple sheets.
--override-channel-info If channel is already present and has different
description/units information, overwrite.
--profile TEXT If provided, use the given named config profile for
instantiating a Nominal Client. This is the
preferred mechanism for instantiating a client
today-- see `nom config profile add` to create a
configuration profile. If provided, takes
precedence over --token, --token-path, and --base-
url. [required]
--trust-store-path FILE Path to a trust store CA root file to initiate SSL
connections. If not provided, defaults to certifi's
trust store.
--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 mis validate¤
Validate units in an MIS file against available units in Nominal.
Usage:
nom mis validate [OPTIONS] MIS_PATH
Options:
--sheet TEXT The sheet to use in the Excel file if parsing
direct from Excel. Only needed if there are
multiple sheets.
--profile TEXT If provided, use the given named config profile for
instantiating a Nominal Client. This is the
preferred mechanism for instantiating a client
today-- see `nom config profile add` to create a
configuration profile. If provided, takes
precedence over --token, --token-path, and --base-
url. [required]
--trust-store-path FILE Path to a trust store CA root file to initiate SSL
connections. If not provided, defaults to certifi's
trust store.
--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, --description TEXT description of the run
--property <TEXT TEXT>...
--label TEXT
--profile TEXT If provided, use the given named config profile
for instantiating a Nominal Client. This is the
preferred mechanism for instantiating a client
today-- see `nom config profile add` to create a
configuration profile. If provided, takes
precedence over --token, --token-path, and
--base-url. [required]
--trust-store-path FILE Path to a trust store CA root file to initiate
SSL connections. If not provided, defaults to
certifi's trust store.
--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]
--profile TEXT If provided, use the given named config profile for
instantiating a Nominal Client. This is the
preferred mechanism for instantiating a client
today-- see `nom config profile add` to create a
configuration profile. If provided, takes
precedence over --token, --token-path, and --base-
url. [required]
--trust-store-path FILE Path to a trust store CA root file to initiate SSL
connections. If not provided, defaults to certifi's
trust store.
--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.