For local commands such as login and mcp, use heaven help COMMAND or the CLI guide.
| Command | Request |
|---|
heaven view [COMPUTER] [--pattern PATTERN] [--pool POOL] [--tag TAG] [--state on|off ...] [--shared] [--limit N] [--after AFTER] [--group GROUP] [-l] [--organization ORGANIZATION] [--scope-pool SCOPE-POOL ...] [--scope-computer SCOPE-COMPUTER ...] [--scope-tag SCOPE-TAG ...] | List or read Computers |
|---|
heaven usage [COMPUTER] [--range 24h|7d|30d] [--resolution 1m|5m|1h] [--points N] [--organization ORGANIZATION] [--pool POOL] | Read a Computer's usage |
|---|
heaven logs COMPUTER [--previous] | Read the boot console |
|---|
heaven create [NAME] [--pool POOL] [--image IMAGE] [--template NAME] [--registry-auth USER:PASSWORD] [--integration INTEGRATION ...] [--github REPO] [--setup-script SCRIPT] [--env KEY=VALUE ...] [--tag TAG ...] [--comment COMMENT] [--domain DOMAIN] [--cpu N] [--memory SIZE] [--disk SIZE] [--copy COMPUTER] [--snapshot SNAPSHOT] [--copy-tags true|false] [--count N] [--names NAMES ...] [--new-pool] [--units N] [--hourly] [--monthly] [--dry-run] [--request-id ID] [--organization ORGANIZATION] [--wait[=DURATION]] | Create a Computer |
|---|
heaven delete COMPUTER... [--request-id ID] | Delete Computers |
|---|
heaven start COMPUTER [--request-id ID] [--wait[=DURATION]] | Start a Computer |
|---|
heaven stop COMPUTER [--request-id ID] [--wait[=DURATION]] | Stop a Computer |
|---|
heaven restart COMPUTER [--request-id ID] [--wait[=DURATION]] | Restart a Computer |
|---|
heaven pause COMPUTER [--request-id ID] | Pause a Computer |
|---|
heaven resume COMPUTER [--request-id ID] | Resume a Computer |
|---|
heaven reset COMPUTER [--image IMAGE] [--setup-script SCRIPT] [--request-id ID] [--dry-run] [--wait[=DURATION]] | Reinstall a Computer |
|---|
heaven rename COMPUTER NAME [--request-id ID] | Rename a Computer |
|---|
heaven move COMPUTER --pool POOL [--request-id ID] [--dry-run] | Move a Computer |
|---|
heaven resize COMPUTER [--cpu N] [--memory SIZE] [--disk SIZE] [--request-id ID] [--wait[=DURATION]] | Resize a Computer |
|---|
heaven tag COMPUTER [TAGS...] [--remove REMOVE ...] [--request-id ID] | Tag a Computer |
|---|
heaven tag view [--prefix PREFIX] [--organization ORGANIZATION] [--limit N] | List tags |
|---|
heaven comment COMPUTER COMMENT [--request-id ID] | Comment on a Computer |
|---|
heaven terminal COMPUTER | Open the browser terminal |
|---|
heaven desktop COMPUTER | Open the desktop |
|---|
heaven access COMPUTER [--qr] | Read who has access |
|---|
heaven share add COMPUTER [--user USER ...] [--team TEAM] [--whole-organization] [--role ROLE] [--command COMMAND ...] [--message MESSAGE] | Share a Computer |
|---|
heaven share remove COMPUTER [--user USER ...] [--team TEAM] [--whole-organization] [--role ROLE] | Stop sharing a Computer |
|---|
heaven share link add COMPUTER [--label LABEL] [--expires DURATION] [--max-uses N] [--qr] | Create a share link |
|---|
heaven share link remove COMPUTER LINK | Remove a share link |
|---|
heaven transfer COMPUTER [--user USER] [--team TEAM] [--whole-organization] [--keep-shares] [--pool POOL] [--request-id ID] | Transfer a Computer |
|---|
heaven grant-support-root COMPUTER on|off | Give support root access |
|---|
heaven website COMPUTER [--access ACCESS] [--public true|false] [--port PORT] | Set who reaches the website |
|---|
heaven port view [COMPUTER] [--organization ORGANIZATION] | List public ports |
|---|
heaven port add COMPUTER GUEST-PORT | Publish a port |
|---|
heaven port remove COMPUTER PORT | Close a port |
|---|
heaven mail view COMPUTER | Read mail settings |
|---|
heaven mail COMPUTER [on|off] [--reply-policy REPLY-POLICY] [--dry-run] | Change mail settings |
|---|
heaven mail status COMPUTER MESSAGE | Read a message's delivery |
|---|
| Command | Request |
|---|
heaven snapshot view [COMPUTER] [SNAPSHOT] [--sort SORT] [--limit N] [--after AFTER] | List or read snapshots |
|---|
heaven snapshot create COMPUTER [NAME] [--note NOTE] [--expires DURATION] [--request-id ID] | Snapshot a Computer |
|---|
heaven snapshot edit COMPUTER SNAPSHOT [--name NAME] [--note NOTE] [--expires DURATION] [--request-id ID] | Change a snapshot |
|---|
heaven snapshot restore COMPUTER SNAPSHOT [--request-id ID] | Restore a snapshot |
|---|
heaven snapshot delete COMPUTER SNAPSHOT... [--request-id ID] | Delete snapshots |
|---|
| Command | Request |
|---|
heaven exec COMPUTER [COMMAND...] [--download DOWNLOAD] [--upload UPLOAD] [--mode MODE] | Run a command |
|---|
heaven export COMPUTER | Export a disk |
|---|
| Command | Request |
|---|
heaven template view [--organization ORGANIZATION] | List templates |
|---|
| Command | Request |
|---|
heaven pool view [POOL] [--part PART ...] [--organization ORGANIZATION] | List or read pools |
|---|
heaven pool usage [POOL] [--range 24h|7d|30d] [--resolution 1m|5m|1h] [--points N] [--organization ORGANIZATION] | Read a pool's usage |
|---|
heaven pool create [NAME] [--buy PLAN] [--monthly] [--hourly] [--months MONTHS] [--offer OFFER] [--dry-run] [--memory SIZE] [--units N] [--server SERVER] [--copy POOL] [--snapshot SNAPSHOT] [--request-id ID] [--organization ORGANIZATION] | Create a pool |
|---|
heaven pool delete POOL [--release] [--dry-run] [--request-id ID] [--organization ORGANIZATION] | Delete a pool |
|---|
heaven pool start POOL [--organization ORGANIZATION] | Start a pool |
|---|
heaven pool stop POOL [--organization ORGANIZATION] | Stop a pool |
|---|
heaven pool pause POOL [--organization ORGANIZATION] | Pause a pool |
|---|
heaven pool resume POOL [--organization ORGANIZATION] | Resume a pool |
|---|
heaven pool stop-last POOL on|off [--organization ORGANIZATION] | Keep a pool running longest |
|---|
heaven pool resize POOL [--memory SIZE] [--units N] [--buy PLAN] [--buy-rest monthly|hourly] [--monthly] [--hourly] [--months MONTHS] [--offer OFFER] [--release] [--dry-run] [--request-id ID] [--organization ORGANIZATION] | Resize a pool |
|---|
heaven pool rename POOL NAME [--organization ORGANIZATION] | Rename a pool |
|---|
heaven pool split POOL [--name NAME] [--memory SIZE] [--computer COMPUTER ...] [--request-id ID] [--dry-run] [--organization ORGANIZATION] | Split a pool |
|---|
heaven pool combine POOL WITH [--request-id ID] [--dry-run] [--organization ORGANIZATION] | Combine pools |
|---|
heaven pool transfer POOL [--to TO] [--request-id ID] [--dry-run] [--organization ORGANIZATION] | Transfer a pool |
|---|
heaven pool defaults set POOL [--setup-script SCRIPT] [--cpu N] [--disk SIZE] [--domain DOMAIN] [--organization ORGANIZATION] | Set pool defaults |
|---|
heaven pool defaults clear POOL [DEFAULT...] [--organization ORGANIZATION] | Clear pool defaults |
|---|
heaven pool share add POOL [--user USER ...] [--with-organization WITH-ORGANIZATION] [--team TEAM] [--role ROLE] [--command COMMAND ...] [--organization ORGANIZATION] | Share a pool |
|---|
heaven pool share remove POOL [--user USER ...] [--with-organization WITH-ORGANIZATION] [--team TEAM] [--organization ORGANIZATION] | Stop sharing a pool |
|---|
| Command | Request |
|---|
heaven pool snapshot view [POOL] [SNAPSHOT] [--shared true|false] [--organization ORGANIZATION] | List or read pool snapshots |
|---|
heaven pool snapshot create POOL [NAME] [--note NOTE] [--expires DURATION] [--request-id ID] [--organization ORGANIZATION] | Snapshot a pool |
|---|
heaven pool snapshot edit POOL SNAPSHOT [--name NAME] [--note NOTE] [--expires DURATION] [--organization ORGANIZATION] | Change a pool snapshot |
|---|
heaven pool snapshot restore POOL SNAPSHOT [--request-id ID] [--organization ORGANIZATION] | Restore a pool snapshot |
|---|
heaven pool snapshot delete POOL SNAPSHOT [--request-id ID] [--organization ORGANIZATION] | Delete a pool snapshot |
|---|
heaven pool snapshot share add POOL SNAPSHOT --user USER ... [--message MESSAGE] [--organization ORGANIZATION] | Share a pool snapshot |
|---|
heaven pool snapshot share remove POOL SNAPSHOT --user USER ... [--organization ORGANIZATION] | Stop sharing a pool snapshot |
|---|
| Command | Request |
|---|
heaven capacity view [--organization ORGANIZATION] | Read your capacity |
|---|
heaven plan view | List plans |
|---|
heaven capacity buy [--plan N] [--monthly] [--hourly] [--months MONTHS] [--offer OFFER] [--dry-run] [--server SERVER] [--request-id ID] [--organization ORGANIZATION] | Buy capacity |
|---|
heaven capacity resize CAPACITY [--plan N] [--dry-run] [--organization ORGANIZATION] | Change a purchase's plan |
|---|
heaven capacity switch CAPACITY [--monthly] [--hourly] [--dry-run] [--organization ORGANIZATION] | Switch monthly or hourly |
|---|
heaven capacity cancel-change CAPACITY [--organization ORGANIZATION] | Cancel a scheduled change |
|---|
heaven capacity release CAPACITY [--dry-run] [--organization ORGANIZATION] | Release capacity |
|---|
| Command | Request |
|---|
heaven ip view [--organization ORGANIZATION] | List static addresses |
|---|
heaven ip buy [--region REGION] [--count N] [--address ADDRESS] [--request-id ID] [--organization ORGANIZATION] | Buy static addresses |
|---|
heaven ip attach [ADDRESS] [COMPUTER] [--pool POOL] [--account] [--server SERVER] [--attachment ATTACHMENT ...] [--organization ORGANIZATION] | Attach static addresses |
|---|
heaven ip detach ADDRESS... [--computer COMPUTER] [--pool POOL] [--organization ORGANIZATION] | Detach static addresses |
|---|
heaven ip release ADDRESS... [--dry-run] [--organization ORGANIZATION] | Release static addresses |
|---|
| Command | Request |
|---|
heaven organization view [--organization ORGANIZATION] | List or read organizations |
|---|
heaven organization usage [--organization ORGANIZATION] | Read an organization's usage |
|---|
heaven audit view [--query QUERY] [--actor ACTOR] [--action ACTION] [--since SINCE] [--before BEFORE] [--limit N] [--format FORMAT] [--organization ORGANIZATION] | Read the audit log |
|---|
heaven organization create NAME | Create an organization |
|---|
heaven organization delete [--dry-run] [--cancel] [--organization ORGANIZATION] | Close an organization |
|---|
heaven organization rename NAME [--organization ORGANIZATION] | Rename an organization |
|---|
heaven organization setting SETTING VALUE [--organization ORGANIZATION] | Change an organization's setting |
|---|
heaven organization member view [--organization ORGANIZATION] | List members |
|---|
heaven organization member add USER [ROLE] [--grant GRANT ...] [--withhold WITHHOLD ...] [--team TEAM ...] [--organization ORGANIZATION] | Invite a member |
|---|
heaven organization member role USER [ROLE] [--grant GRANT ...] [--withhold WITHHOLD ...] [--organization ORGANIZATION] | Change a member's access |
|---|
heaven organization member remove USER [--transfer-computers-to USER] [--to-team TO-TEAM] [--to-organization] [--keep-shares] [--organization ORGANIZATION] | Remove a member |
|---|
heaven organization leave [--transfer-computers-to USER] [--to-team TO-TEAM] [--to-organization] [--keep-shares] [--organization ORGANIZATION] | Leave an organization |
|---|
heaven organization invitation view [--organization ORGANIZATION] | List sent invitations |
|---|
heaven organization invitation cancel INVITATION [--organization ORGANIZATION] | Cancel an invitation |
|---|
heaven organization link add [--role ROLE] [--organization ORGANIZATION] | Get a join link |
|---|
heaven organization link view [--organization ORGANIZATION] | List join links |
|---|
heaven organization link remove [--role ROLE] [--organization ORGANIZATION] | Remove a join link |
|---|
| Command | Request |
|---|
heaven organization team view [TEAM] [--organization ORGANIZATION] | List or read teams |
|---|
heaven organization team create NAME [--user USER ...] [--organization ORGANIZATION] | Create a team |
|---|
heaven organization team rename TEAM NAME [--organization ORGANIZATION] | Rename a team |
|---|
heaven organization team setting TEAM SETTING VALUE [--organization ORGANIZATION] | Change a team's setting |
|---|
heaven organization team member add TEAM USER [ROLE] [--organization ORGANIZATION] | Add a team member |
|---|
heaven organization team member role TEAM USER ROLE [--organization ORGANIZATION] | Change a team member's role |
|---|
heaven organization team member remove TEAM USER [--organization ORGANIZATION] | Remove a team member |
|---|
heaven organization team leave TEAM [--organization ORGANIZATION] | Leave a team |
|---|
heaven organization team delete TEAM [--organization ORGANIZATION] | Delete a team |
|---|
| Command | Request |
|---|
heaven billing view [--organization ORGANIZATION] | Read billing |
|---|
heaven billing cost [--organization ORGANIZATION] | Read this month's cost |
|---|
heaven billing history [--before BEFORE] [--limit N] [--organization ORGANIZATION] | List charges |
|---|
heaven billing top-up [--amount DOLLARS] [--auto-top-up AUTO-TOP-UP] [--no-auto-top-up] [--invoice] [--organization ORGANIZATION] | Top up the wallet |
|---|
heaven billing charge --amount DOLLARS [--request-id ID] [--organization ORGANIZATION] | Charge your saved card |
|---|
heaven billing auto-top-up [--amount DOLLARS] [--monthly-limit MONTHLY-LIMIT] [--off] [--organization ORGANIZATION] | Set automatic top-up |
|---|
heaven billing refund [--organization ORGANIZATION] | Refund the wallet |
|---|
heaven billing redeem CODE [--organization ORGANIZATION] | Redeem an offer |
|---|
heaven billing invoices [--organization ORGANIZATION] | List invoices |
|---|
heaven billing pay [INVOICE] [--organization ORGANIZATION] | Pay an invoice |
|---|
heaven billing details view [--organization ORGANIZATION] | Read invoice details |
|---|
heaven billing details set [--organization ORGANIZATION] [--email EMAIL] [--company COMPANY] [--tax-id TAX-ID] [--postal-address LINE1] [--line2 LINE2] [--city CITY] [--state STATE] [--postal-code POSTAL-CODE] [--country COUNTRY] | Set invoice details |
|---|
heaven billing card setup [--organization ORGANIZATION] | Start saving a card |
|---|
heaven billing card save SETUP [--organization ORGANIZATION] | Save a card |
|---|
heaven billing portal [--organization ORGANIZATION] | Open the billing portal |
|---|
heaven billing egress-cap [--amount DOLLARS] [--off] [--default] [--organization ORGANIZATION] | Set the egress cap |
|---|
heaven billing spend-alert [--amount DOLLARS] [--off] [--organization ORGANIZATION] | Set the spend alert |
|---|
heaven billing spending-cap [--amount DOLLARS] [--off] [--organization ORGANIZATION] | Set the spending cap |
|---|
heaven billing usage-emails [--on] [--off] [--organization ORGANIZATION] | Turn usage notices on or off |
|---|
heaven billing contact view [--organization ORGANIZATION] | List billing contacts |
|---|
heaven billing contact add EMAIL [--organization ORGANIZATION] | Add a billing contact |
|---|
heaven billing contact remove EMAIL [--organization ORGANIZATION] | Remove a billing contact |
|---|
| Command | Request |
|---|
heaven integration view [--organization ORGANIZATION] | List integrations |
|---|
heaven integration create KIND [--name NAME] [--target TARGET] [--header HEADER ...] [--bearer BEARER] [--basic-auth BASIC-AUTH] [--strip-prefix STRIP-PREFIX] [--attachment ATTACHMENT ...] [--comment COMMENT] [--peer] [--no-auth] [--read-only true|false] [--organization ORGANIZATION] | Create an integration |
|---|
heaven integration edit INTEGRATION [--target TARGET] [--header HEADER ...] [--remove-header REMOVE-HEADER ...] [--bearer BEARER] [--basic-auth BASIC-AUTH] [--strip-prefix STRIP-PREFIX] [--attachment ATTACHMENT ...] [--comment COMMENT] [--peer] [--no-auth] [--read-only true|false] [--reconnect] [--organization ORGANIZATION] | Change an integration |
|---|
heaven integration attach INTEGRATION ATTACHMENT... [--organization ORGANIZATION] | Attach an integration |
|---|
heaven integration detach INTEGRATION [ATTACHMENT...] [--all] [--organization ORGANIZATION] | Detach an integration |
|---|
heaven integration rename INTEGRATION NAME [--organization ORGANIZATION] | Rename an integration |
|---|
heaven integration pause INTEGRATION [--organization ORGANIZATION] | Pause an integration |
|---|
heaven integration resume INTEGRATION [--organization ORGANIZATION] | Resume an integration |
|---|
heaven integration delete INTEGRATION [--organization ORGANIZATION] | Delete an integration |
|---|
heaven integration repo view INTEGRATION [--organization ORGANIZATION] | List a GitHub integration's repositories |
|---|
| Command | Request |
|---|
heaven api-key view [--all] | List API keys |
|---|
heaven api-key create [--label LABEL] [--expires DURATION] [--command COMMAND ...] [--scope-pool SCOPE-POOL ...] [--scope-computer SCOPE-COMPUTER ...] [--scope-tag SCOPE-TAG ...] [--organization ORGANIZATION] | Create an API key |
|---|
heaven api-key edit KEY [--label LABEL] [--expires DURATION] [--command COMMAND ...] [--scope-pool SCOPE-POOL ...] [--scope-computer SCOPE-COMPUTER ...] [--scope-tag SCOPE-TAG ...] [--no-scope] | Change an API key |
|---|
heaven api-key rotate KEY [--overlap OVERLAP] | Rotate an API key |
|---|
heaven api-key remove KEY | Remove an API key |
|---|
| Command | Request |
|---|
heaven operation view OPERATION [--wait] [--timeout DURATION] | Read an operation |
|---|
| Command | Request |
|---|
heaven feedback TEXT [--computer COMPUTER] [--request-id ID] | Send feedback |
|---|