sum-cli 3.0.0

SUM Platform CLI: single control plane for site lifecycle management

SUM CLI (v3)

The SUM CLI is the single control plane for deploying and managing SUM Platform client sites.

Install

pip install sum-cli
sum-platform --version

With Gitea Support

If using Gitea instead of GitHub for repository hosting:

pip install sum-cli[gitea]

Quick Usage

# Create a new production site (requires sudo)
sudo sum-platform init acme --theme theme_a

# Create site with custom content profile
sudo sum-platform init acme --content-path /path/to/profiles/acme

# Update a deployed site
sum-platform update acme

# Backup a site
sum-platform backup acme --include-media

# Promote staging to production
sum-platform promote acme --domain acme.example.com

# List available themes
sum-platform themes

# Validate a project setup
sum-platform check acme

Commands

Command	Description	Requires Sudo
init	Create new site at /srv/sum/<name>/	Yes
update	Pull updates, migrate, restart	No (staging)
backup	Database and media backup	No
promote	Deploy staging site to production	No
check	Validate project setup	No
themes	List available themes	No
run	Start development server	No

Git Provider Support

The CLI supports both GitHub and Gitea for repository hosting. Configure your provider in /etc/sum/config.yml:

GitHub (default):

agency:
  name: "Your Agency"
  git_provider: "github"
  github_org: "your-org"

Gitea:

agency:
  name: "Your Agency"
  git_provider: "gitea"
  gitea_url: "https://gitea.example.com"
  gitea_org: "your-org"
  gitea_token_env: "GITEA_TOKEN"

For Gitea, set the GITEA_TOKEN environment variable with your API token.

Development Install (monorepo)

pip install -e ./cli

Configuration

System-wide configuration is read from /etc/sum/config.yml. See config.yml.example for the full schema.

Documentation

The full User Guide is bundled with the package at sum/docs/USER_GUIDE.md.

For monorepo development:

• User Guide - Full command reference
• Developer Guide - CLI architecture and contribution guide