Skip to Content
CLI ReferenceOverview

CLI Reference

The lobster CLI is the primary way to manage cages from your terminal.

Installation

npm install -g lobstercage-cli

Authentication

lobster login # Opens browser to authenticate lobster logout # Clear local credentials lobster whoami # Show current user

Quick reference

CategoryCommands
Authlogin, logout, whoami
Cagesdeploy, list, status, destroy
Lifecyclestart, stop, hibernate, wake
Connectssh, exec, port-forward, tunnel, dashboard
Env varsenv list, env set, env get, env delete, env scan
API keysapikeys list, apikeys create, apikeys revoke
Billingbilling status, billing portal, upgrade
Logslogs, tail

See the full command reference for details on every command.