Skip to main content

Quick Start

First Run

On first run, spot will automatically create a configuration directory at ~/.spot/ with authentication credentials:

spot connect my-resource --token <your-token>

The configuration includes authentication tokens and has secure file permissions (0600)

Shell Configuration

For easier usage, add these to your ~/.profile or ~/.bashrc:

export PATH="${HOME}/.local/bin:${PATH}"
source <(spot completion bash)

This ensures spot is in your PATH and enables tab completion.

Connecting to Resources

To connect to a resource:

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

The token is provided by the resource administrator and grants you access to specific resources.

Listing Resources

To see available resources:

spot list

Getting Help

For help with any command:

spot --help
spot <command> --help