CLI Reference

Command-line interface documentation for SiteDash.

Overview

The SiteDash CLI provides command-line access to your dashboard, sites, and configuration. It is included with the desktop application and can also be installed standalone.

Global Options

sitedash [command] [options]

Options:
  --api-key <key>    API token for authentication
  --format <fmt>     Output format: table (default), json, csv
  --verbose          Enable verbose logging
  --version          Print the CLI version
  --help             Show help for a command

Commands

sitedash sites list

List all monitored sites.

sitedash sites list
sitedash sites list --format json
sitedash sites list --tag production

sitedash sites add

Add a new site to your dashboard.

sitedash sites add https://example.com --name "My Site"

sitedash sites scan

Trigger a security scan for a specific site.

sitedash sites scan --site-id 42
sitedash sites scan --url https://example.com

sitedash config set / get / reset

Manage local configuration values.

sitedash config set check_interval 300
sitedash config get check_interval
sitedash config reset --all

sitedash releases list

View available SiteDash releases.

sitedash releases list
sitedash releases list --format json

sitedash auth login / logout

Authenticate the CLI with your SiteDash account.

sitedash auth login
sitedash auth logout

Exit Codes

  • 0 — Success
  • 1 — General error
  • 2 — Authentication error
  • 3 — Network error