Skip to content

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:

  • login logout
  • status refresh
  • methods active activate
  • config verify
  • generate

Use this family when you first connect to an instance, switch auth strategies, or troubleshoot token state.

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 config
  • hbi 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: get about instances
  • log levels: log-levels update-log-levels
  • config families: environment everest security smtp home
  • page and style settings: app-mart-tag list-sort skin css js
  • other settings: gis open-dwinfo
  • key-based access: get-config set-config

Use this family for system inspections, environment checks, and configuration previews.

scheduler

Purpose: manage existing schedules.

Common subcommands:

  • list show
  • update delete
  • switch
  • context
  • logs

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

ScenarioStart with
sign in, switch auth methods, or inspect token stateauth
search across folders for apps, dashboards, or datasetssearch
inspect or edit local CLI configconfig
inspect system-level preferencespreferences
manage existing schedulesscheduler
download system logslogs

When you need exact flags, parameters, or examples, use that command tree's --help in the terminal.

User Manual for Hengshi Analysis Platform