Core & Runtime Commands
This page covers the cross-domain commands that are closest to the hbi-core skill.
auth
Purpose: log in, switch authentication methods, and inspect the current credential state.
Common subcommands:
loginlogoutstatusrefreshmethodsactiveactivateconfigverifygenerate
Use this family when you first connect to an instance, switch auth strategies, or troubleshoot token state.
search
Purpose: search apps, dashboards, and datasets across folder trees.
This command does not have second-level subcommands. The important parameters are:
--area--root/--folder--recursive--type--query
When you do not know which folder or app contains the resource, start with the search command tree.
config
Purpose: inspect or edit local CLI configuration.
This command does not have second-level subcommands. The most common forms are:
hbi confighbi config --edit
Use it when you need to inspect what the CLI is reading locally or open the interactive editor.
preferences
Purpose: read or update system-level preferences.
Common subcommands:
- general inspection:
getaboutinstances - log levels:
log-levelsupdate-log-levels - config families:
environmenteverestsecuritysmtphome - page and style settings:
app-mart-taglist-sortskincssjs - other settings:
gisopen-dwinfo - key-based access:
get-configset-config
Use this family for system inspections, environment checks, and configuration previews.
scheduler
Purpose: manage existing schedules.
Common subcommands:
listshowupdatedeleteswitchcontextlogs
Use it to inspect notebook, pipeline, dataset, data-alert, app-refresh, and other schedule instances that already exist.
logs
Purpose: download system logs.
Common subcommands:
download
This family is mainly used in troubleshooting and operations.
Where to drill down next
| Scenario | Start with |
|---|---|
| sign in, switch auth methods, or inspect token state | auth |
| search across folders for apps, dashboards, or datasets | search |
| inspect or edit local CLI config | config |
| inspect system-level preferences | preferences |
| manage existing schedules | scheduler |
| download system logs | logs |
When you need exact flags, parameters, or examples, use that command tree's --help in the terminal.