Skip to content

Configuration reference

Generated from the Pydantic models in nsc/config/models.py. All fields below describe ~/.nsc/config.yaml.

Config

Field Type Default
default_profile str | None None
profiles dict[str, Profile] {}
defaults <class 'Defaults'> Defaults(output=<OutputFormat.TABLE: 'table'>, page_size=50, timeout=30.0, schema_refresh=<SchemaRefresh.ON_HASH_CHANGE: 'on-hash-change'>)
columns dict[str, dict[str, list[str]]] {}

Profile

Field Type Default
name <class 'str'> (required)
url <class 'pydantic.networks.HttpUrl'> (required)
token str | None None
verify_ssl <class 'bool'> True
schema_url pydantic.networks.HttpUrl | None None
timeout float | None None

Defaults

Field Type Default
output <enum 'OutputFormat'> <OutputFormat.TABLE: 'table'>
page_size <class 'int'> 50
timeout <class 'float'> 30.0
schema_refresh <enum 'SchemaRefresh'> <SchemaRefresh.ON_HASH_CHANGE: 'on-hash-change'>