Overview - Hoista

hoist is Hoista’s command line. Everything the desktop app does, it does too, on this computer’s Hoista or on a remote. Run a command without its arguments in a terminal and it asks for what’s missing; in a script, pass everything and add --json.

hoist accounts add railway       # connect a provider account
hoist import                     # bring in what already runs there
hoist deploy                     # deploy the folder you're in
hoist logs my-app -f             # follow its logs

Install the CLI

The installer puts hoist and hoistd side by side. See Install, then check it:

hoist --version
hoist doctor

Global flags

These work with every command, before or after it.

Flag	What it does
`--json`	Print JSON instead of tables and messages. A list prints as a JSON array.
`-y`, `--yes`	Answer yes to every confirmation. Deleting still needs `--confirm NAME`.
`--no-input`	Never ask; stop with the flag to pass instead. On by itself when `CI` is set or there’s no terminal.
`--remote NAME`	Use this remote for one command. Also `HOISTA_REMOTE`. `this-computer` means this computer.
`-e`, `--environment NAME`	Use this environment for one command. Also `HOISTA_ENVIRONMENT`.
`--state-dir PATH`	Use another state folder instead of `~/.hoista`. Each has its own projects, accounts and agents.

In scripts and CI

Pass every argument. A missing one is an error that names the flag, never a prompt.
Add --json and read stdout. Progress and confirmations go to stderr.
Pipe secrets: --token-stdin, --value-stdin, --passphrase-stdin or --file .env. Never put a token or value in an argument.
Exit codes: 0 worked, 1 failed, 2 the command was called wrong or needs input it didn’t get.
NO_COLOR=1 turns colour off; it’s off already when output isn’t a terminal.

export HOISTA_REMOTE=office HOISTA_ENVIRONMENT=production
op read op://Work/stripe/key | hoist env set my-app STRIPE_KEY --value-stdin
hoist deploy ./web -p my-web --json | jq -r .id

Shell completion

hoist completion zsh > "${fpath[1]}/_hoist"                              # zsh
hoist completion bash > ~/.local/share/bash-completion/completions/hoist  # bash
hoist completion fish > ~/.config/fish/completions/hoist.fish             # fish

Commands

Projects

List, import, link, rename and delete projects.

Resources and databases

Restart, pause, move and delete services and databases.

Deploying

Plan a deploy, follow it, roll back or cancel.

Variables and domains

Environment variables and custom domains.

Watching

Logs, metrics, activity, billing and usage.

Accounts and providers

Connect provider accounts, check and rotate tokens.

Environments

Production, staging and the one in use.

Remotes

Run Hoista on a server and switch between them.

Agents

Let coding agents in and choose what they may do.

Safety and upkeep

Backups, operations, webhooks and settings.

This computer

Start the engine, run checks, install the service.

​Install the CLI

​Global flags

​In scripts and CI

​Shell completion

​Commands