Skip to content

CLI Documentation

This document contains the CLI commands and their descriptions.

This file is auto-generated by the typer docs utility (docs/compile-cli.py).

svs

Usage:

$ svs [OPTIONS] COMMAND [ARGS]...

Options:

  • --install-completion: Install completion for the current shell.
  • --show-completion: Show completion for the current shell, to copy it or customize the installation.
  • --help: Show this message and exit.

Commands:

  • user: Manage users
  • template: Manage Docker templates
  • service: Manage Docker services

svs user

Manage users

Usage:

$ svs user [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • create: Create a new user
  • get: Get a user by name
  • check-password: Check if a password matches the stored hash
  • list: List all users

svs user create

Create a new user

Usage:

$ svs user create [OPTIONS] NAME PASSWORD

Arguments:

  • NAME: Username of the new user [required]
  • PASSWORD: Password for the new user [required]

Options:

  • --help: Show this message and exit.

svs user get

Get a user by name

Usage:

$ svs user get [OPTIONS] NAME

Arguments:

  • NAME: Username of the user to retrieve [required]

Options:

  • --help: Show this message and exit.

svs user check-password

Check if a password matches the stored hash

Usage:

$ svs user check-password [OPTIONS] NAME PASSWORD

Arguments:

  • NAME: Username of the user [required]
  • PASSWORD: Password to check against the stored hash [required]

Options:

  • --help: Show this message and exit.

svs user list

List all users

Usage:

$ svs user list [OPTIONS]

Options:

  • --help: Show this message and exit.

svs template

Manage Docker templates

Usage:

$ svs template [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • create: Create a new template.
  • get: Get a template by id.
  • list: List all templates.
  • import-url: Import a template from a Dockerfile URL.
  • discover-gh: Discover templates from a GitHub repository.

svs template create

Create a new template.

Usage:

$ svs template create [OPTIONS] NAME DOCKERFILE

Arguments:

  • NAME: Template name [required]
  • DOCKERFILE: Dockerfile content [required]

Options:

  • --description TEXT: Template description
  • --exposed-ports TEXT: Comma-separated list of exposed ports
  • --help: Show this message and exit.

svs template get

Get a template by id.

Usage:

$ svs template get [OPTIONS] ID

Arguments:

  • ID: Template ID [required]

Options:

  • --help: Show this message and exit.

svs template list

List all templates.

Usage:

$ svs template list [OPTIONS]

Options:

  • --help: Show this message and exit.

svs template import-url

Import a template from a Dockerfile URL.

Usage:

$ svs template import-url [OPTIONS] URL

Arguments:

  • URL: URL to Dockerfile [required]

Options:

  • --help: Show this message and exit.

svs template discover-gh

Discover templates from a GitHub repository.

Usage:

$ svs template discover-gh [OPTIONS] REPO_URL

Arguments:

  • REPO_URL: GitHub repository URL [required]

Options:

  • --help: Show this message and exit.

svs service

Manage Docker services

Usage:

$ svs service [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • create: Create a new service.
  • get: Get a service by id.
  • list: List all services.

svs service create

Create a new service.

Usage:

$ svs service create [OPTIONS] NAME TEMPLATE_ID USER_ID

Arguments:

  • NAME: Service name [required]
  • TEMPLATE_ID: Template ID [required]
  • USER_ID: User ID [required]

Options:

  • --domain TEXT: Domain for the service
  • --help: Show this message and exit.

svs service get

Get a service by id.

Usage:

$ svs service get [OPTIONS] ID

Arguments:

  • ID: Service ID [required]

Options:

  • --help: Show this message and exit.

svs service list

List all services.

Usage:

$ svs service list [OPTIONS]

Options:

  • --help: Show this message and exit.