Skip to content

config:explain

rai config:explain [OPTIONS]

Display configuration details for the active profile with sensitive details redacted.

Options

Option	Type	Description
`--profile`	Text	The profile to display. If missing, the active profile is used.
`--all-profiles`		Display all profiles. If missing, only the profile specified by the `--profile` option is displayed.

Example

Use the config:explain command to view configuration status of the active profile:

$ rai config:explain

---------------------------------------------------

/path/to/raiconfig.toml

[profile.default]
platform = snowflake
user = jane.doe@company.com
password = ************
account = "plvoura-client_solutions"
role = "ACCOUNTADMIN"
warehouse = "MY_WAREHOUSE"
rai_app_name = "RELATIONALAI"
engine = "jane_doe"

---------------------------------------------------

Use the --profile option to view details for a specific profile:

rai config:explain --profile my-profile

To display all profiles in the configuration file, use the --all-profiles option:

rai config:explain --all-profiles

Missing information is indicated by a question mark (?). The following output indicates that the password and engine fields are missing:

$ rai config:explain

---------------------------------------------------

/path/to/raiconfig.toml

[profile.default]
platform = snowflake
user = jane.doe@company.com
account = "plvoura-client_solutions"
role = "ACCOUNTADMIN"
warehouse = "MY_WAREHOUSE"
rai_app_name = "RELATIONALAI"
password = ?
engine = ?

---------------------------------------------------

See Also