HubDocs

CLI reference

CLI reference. Every hub command and option.

Install the CLI with npm. It needs Node.js 22.12 or newer.

npm install --global @hubhq/cli@latest

Commands that act on one app start with hub app <name>. The name is the app, or app/instance for an instance other than prod, such as my-app/staging. In a terminal, hub --help, hub app my-app --help and hub app my-app logs --help print the same text as these pages.

Account

CommandDescription
hub loginLog in, or create an account.
hub logoutForget the saved login.
hub whoamiShow who is logged in.

Apps

CommandDescription
hub deployDeploy a folder, or a GitHub repository with --git.
hub appsList your apps and their instances.
hub app <name>Check, share and run one app.

Team

CommandDescription
hub inviteInvite someone to your org.
hub membersList the members of your org.
hub leaveLeave your org.

More

CommandDescription
hub workspaceManage the org workspace.
hub validateCheck the hub.yaml in an app folder.

Global options

Every command takes these, and --help.

OptionDescription
-V, --versionOutput the version number.
--url <url>Control plane URL, overrides the saved login and config.

Examples

# Log in, or create an account
hub login

# Deploy the folder you are in
hub deploy

# List your apps
hub apps

# Follow build and runtime logs
hub app my-app logs

# Everything you can do with one app
hub app my-app --help

On this page