← CLI Reference

share

Share HTTPS VM access with others

Usage

share <subcommand> <vm> [args...]

Options

  • --json: output in JSON format

Subcommands

share show

Show current shares for a VM

Usage:

share show <vm>

Options:

  • --json: output in JSON format
  • --qr: show QR code for the URL

share port

Set the HTTP proxy port for a VM

Usage:

share port <vm> [port]

Options:

  • --json: output in JSON format

Examples:

share port mybox 8080

share set-public

Make the HTTP proxy publicly accessible

Usage:

share set-public <vm>

Options:

  • --json: output in JSON format

share set-private

Restrict the HTTP proxy to authenticated users

Usage:

share set-private <vm>

Options:

  • --json: output in JSON format

share add

Share VM with a user via email, or grant shell access with --root

Usage:

share add <vm> <email|team> [--root] [--message='...']

Options:

  • --json: output in JSON format
  • --message: message to include in share invitation
  • --qr: show QR code for the URL
  • --root: grant/revoke shell (SSH, Terminal, Shelley) access instead of web-only

Examples:

share add mybox user@example.com
share add mybox user@example.com --message='Check this out'
share add mybox team
share add mybox teammate@example.com --root
share add mybox team --root

share remove

Revoke a user's access to a VM, or downgrade shell access to web with --root

Usage:

share remove <vm> <email|team> [--root]

Options:

  • --json: output in JSON format
  • --root: grant/revoke shell (SSH, Terminal, Shelley) access instead of web-only

Examples:

share remove mybox user@example.com
share remove mybox team
share remove mybox teammate@example.com --root
share remove mybox team --root

Create a shareable link for a VM

Usage:

share add-link <vm>

Aliases: add-share-link

Options:

  • --json: output in JSON format
  • --qr: show QR code for the URL

Revoke a shareable link

Usage:

share remove-link <vm> <token>

Aliases: remove-share-link

Options:

  • --json: output in JSON format

share receive-email

Enable or disable inbound email for a VM

Usage:

share receive-email <vm> [on|off] [--reply-policy=all|known|owner|none]

Options:

  • --json: output in JSON format
  • --reply-policy: restrict who the VM may email: all|known|owner|none

Examples:

share receive-email mybox on
share receive-email mybox off
share receive-email mybox --reply-policy=known
share receive-email mybox