config

Configuration Commands

usage: ngc config [--debug] [--format_type <fmt>] [-h]
                  {clear,clear-cache,current,set} ...

Named Arguments

--debug

Enable debug mode.

--format_type

Possible choices: ascii, csv, json

Specify the output format type. Supported formats are: ['ascii', 'csv', 'json']. Only commands that produce tabular data support csv format. Default: ascii

config

{clear,clear-cache,current,set}

Possible choices: clear, clear-cache, current, set

Sub-commands

clear

Clear the configuration stored in the user settings file.

ngc config clear [--debug] [--format_type <fmt>] [-h]

Named Arguments

--debug

Enable debug mode.

--format_type

Possible choices: ascii, csv, json

Specify the output format type. Supported formats are: ['ascii', 'csv', 'json']. Only commands that produce tabular data support csv format. Default: ascii

clear-cache

Clear cached values.

ngc config clear-cache [--debug] [--format_type <fmt>] [-h]

Named Arguments

--debug

Enable debug mode.

--format_type

Possible choices: ascii, csv, json

Specify the output format type. Supported formats are: ['ascii', 'csv', 'json']. Only commands that produce tabular data support csv format. Default: ascii

set

Set the configuration in the user settings file. Use optional arguments to choose what will be set.

ngc config set [--auth-option {api-key,email}] [--debug] [--format_type <fmt>]
               [-h]

Named Arguments

--debug

Enable debug mode.

--format_type

Possible choices: ascii, csv, json

Specify the output format type. Supported formats are: ['ascii', 'csv', 'json']. Only commands that produce tabular data support csv format. Default: ascii

--auth-option

Possible choices: api-key, email

Specify authentication option ('api key' or 'email') for setting config.

current

List the current configuration.

ngc config current [--debug] [--format_type <fmt>] [--show-auth-token] [--yes]
                   [-h]

Named Arguments

--debug

Enable debug mode.

--format_type

Possible choices: ascii, csv, json

Specify the output format type. Supported formats are: ['ascii', 'csv', 'json']. Only commands that produce tabular data support csv format. Default: ascii

--show-auth-token

Show the Docker login password (Starfleet ID Token) if this flag is set.

--yes

Automatically confirm the retrieval of the auth token without prompting.

Examples

How to set config?

$ ngc config set --format_type json

Successfully saved NGC configuration C:\Users\<username>\.ngc\config

$ ngc config set

Enter API key[**************************************************************************************Q1Nw]:
Enter CLI output format type [ascii]. Choices: ['ascii', 'csv', 'json']
Enter default org [b0xlotzw8zo9]. Choices: [b0xlotzw8zo9, nvidia]:
Successfully saved NGC configuration C:\Users\foo\.ngc\config

How to clear config?

$ ngc config clear

Successfully cleared NGC configuration C:\Users\<username>\.ngc\config