Skip to main content

Spot CLI Utility

The spot command-line interface is a secure proxy utility for accessing Spotrun resources.

Find more information at: https://spot.run

Usage​

spot [options] <command>
spot [options] <command> -h
spot -h
spot help

Global Options​

  • -c string - Path to config file or directory
  • -v - Verbose output

Setup Commands​

login​

Authenticate with spot.run:

spot login

logout​

Remove local authentication:

spot logout

Resource Commands​

get​

List resources of a certain type:

spot get <resource-type>
spot get <resource-type> -h

create​

Create new resources:

spot create <resource-type> [options]
spot create <resource-type> -h

delete​

Delete a resource:

spot delete <resource-type> <resource-name>
spot delete <resource-type> -h

connect​

Connect to a resource via tunnel:

spot connect <resource-name> --token <token>
spot connect -h

Arguments:

  • resource-name - Name of the resource to connect to
  • --token - Authentication token (required)

describe​

Display detailed information about a resource:

spot describe <resource-type> <resource-name>
spot describe <resource-type> -h

Authentication Commands​

keys​

Manage public keys:

spot keys [subcommand]
spot keys -h

update​

Update the spot CLI to the latest version:

spot update

The update command:

  1. Checks current version
  2. Fetches latest version from server
  3. Compares versions
  4. Downloads and installs if newer version available
  5. Verifies checksum

version​

Show the current version:

spot version

Version format: <semver>-<commit>+<changes>

Example: 0.0.0-b06e2c4+be7d7ff

completion​

Generate shell completion scripts:

spot completion bash
spot completion zsh
spot completion fish

To enable completions, add to your shell's rc file:

source <(spot completion bash)

help​

Show help for any command:

spot --help
spot <command> --help