CLI Reference¶

This section provides details on using the custom tux command-line interface, built with Click.

Environment Selection¶

The tux CLI defaults to development mode for all command groups (bot, db, dev, docker). This ensures that operations like database migrations or starting the bot target your development resources unless explicitly specified otherwise.

• Production Mode: To run a command targeting production resources (e.g., production database, production bot token), you must use the global --prod flag immediately after tux:

  Bash

  # Example: Apply migrations to production database
  poetry run tux --prod db migrate
  
  # Example: Start the bot using production token/DB
  poetry run tux --prod bot start
  

• Development Mode (Default / Explicit): Running any command without --prod automatically uses development mode. You can also explicitly use the --dev flag, although it is redundant.

  Bash

  # These are equivalent and run in development mode:
  poetry run tux db push
  poetry run tux --dev db push
  
  poetry run tux bot start
  poetry run tux --dev bot start
  

This default-to-development approach prioritizes safety by preventing accidental operations on production environments. The environment determination logic can be found in tux/utils/env.py.

tux¶

Tux CLI

Usage:

tux [OPTIONS] COMMAND [ARGS]...

Options:

Subcommands

• db: Database management commands
• dev: Development tools
• docker: Docker management commands
• docs: Documentation related commands
• start: Start the Discord bot
• version: Display the current version of Tux

tux db¶

Database management commands

Usage:

tux db [OPTIONS] COMMAND [ARGS]...

Options:

Subcommands

• generate: Generate Prisma client.
• migrate: Run database migrations.
• pull: Pull schema from database.
• push: Push schema changes to database.
• reset: Reset database.

tux db generate¶

Generate Prisma client.

Usage:

tux db generate [OPTIONS]

Options:

tux db migrate¶

Run database migrations.

Usage:

tux db migrate [OPTIONS]

Options:

tux db pull¶

Pull schema from database.

Usage:

tux db pull [OPTIONS]

Options:

tux db push¶

Push schema changes to database.

Usage:

tux db push [OPTIONS]

Options:

tux db reset¶

Reset database.

Usage:

tux db reset [OPTIONS]

Options:

tux dev¶

Development tools

Usage:

tux dev [OPTIONS] COMMAND [ARGS]...

Options:

Subcommands

• coverage: Generate coverage reports with various options.
• coverage-clean: Clean coverage files and reports.
• coverage-open: Open HTML coverage report in browser.
• format: Format code with Ruff.
• lint: Run linting with Ruff.
• lint-fix: Run linting with Ruff and apply fixes.
• pre-commit: Run pre-commit checks.
• test: Run tests with coverage.
• test-quick: Run tests without coverage (faster).
• type-check: Check types with Pyright.

tux dev coverage¶

Generate coverage reports with various options.

Usage:

tux dev coverage [OPTIONS]

Options:

tux dev coverage-clean¶

Clean coverage files and reports.

Usage:

tux dev coverage-clean [OPTIONS]

Options:

tux dev coverage-open¶

Open HTML coverage report in browser.

Usage:

tux dev coverage-open [OPTIONS]

Options:

tux dev format¶

Format code with Ruff.

Usage:

tux dev format [OPTIONS]

Options:

tux dev lint¶

Run linting with Ruff.

Usage:

tux dev lint [OPTIONS]

Options:

tux dev lint-fix¶

Run linting with Ruff and apply fixes.

Usage:

tux dev lint-fix [OPTIONS]

Options:

tux dev pre-commit¶

Run pre-commit checks.

Usage:

tux dev pre-commit [OPTIONS]

Options:

tux dev test¶

Run tests with coverage.

Usage:

tux dev test [OPTIONS]

Options:

tux dev test-quick¶

Run tests without coverage (faster).

Usage:

tux dev test-quick [OPTIONS]

Options:

tux dev type-check¶

Check types with Pyright.

Usage:

tux dev type-check [OPTIONS]

Options:

tux docker¶

Docker management commands

Usage:

tux docker [OPTIONS] COMMAND [ARGS]...

Options:

Subcommands

• build: Build Docker images.
• cleanup: Clean up Tux-related Docker resources (images, containers, networks).
• config: Validate and display the Docker Compose configuration.
• down: Stop Docker services.
• exec: Execute a command inside a running service container.
• health: Check health status of running Tux containers.
• logs: Show logs for Docker services.
• ps: List running Docker containers.
• pull: Pull the latest Tux images from the registry.
• restart: Restart Docker services.
• shell: Open an interactive shell in a running container.
• test: Run Docker performance and functionality tests.
• up: Start Docker services.

tux docker build¶

Build Docker images.

Runs docker compose build with optional cache and target controls.

Usage:

tux docker build [OPTIONS]

Options:

tux docker cleanup¶

Clean up Tux-related Docker resources (images, containers, networks).

SAFETY: Only removes Tux-related resources, never affects other projects.

Usage:

tux docker cleanup [OPTIONS]

Options:

tux docker config¶

Validate and display the Docker Compose configuration.

Runs docker compose config to show the resolved configuration.

Usage:

tux docker config [OPTIONS]

Options:

tux docker down¶

Stop Docker services.

Runs docker compose down with optional cleanup.

Usage:

tux docker down [OPTIONS]

Options:

tux docker exec¶

Execute a command inside a running service container.

Runs docker compose exec [service] [command].

Usage:

tux docker exec [OPTIONS] [SERVICE] COMMAND...

Options:

tux docker health¶

Check health status of running Tux containers.

Shows health check status for Tux services only.

Usage:

tux docker health [OPTIONS]

Options:

tux docker logs¶

Show logs for Docker services.

Runs docker compose logs [service]. If no service specified, shows logs for all services.

Usage:

tux docker logs [OPTIONS] [SERVICE]

Options:

tux docker ps¶

List running Docker containers.

Runs docker compose ps.

Usage:

tux docker ps [OPTIONS]

Options:

tux docker pull¶

Pull the latest Tux images from the registry.

Runs docker compose pull to update Tux images only.

Usage:

tux docker pull [OPTIONS]

Options:

tux docker restart¶

Restart Docker services.

Runs docker compose restart [service].

Usage:

tux docker restart [OPTIONS] [SERVICE]

Options:

tux docker shell¶

Open an interactive shell in a running container.

Equivalent to docker compose exec [service] bash.

Usage:

tux docker shell [OPTIONS] [SERVICE]

Options:

tux docker test¶

Run Docker performance and functionality tests.

Uses the Python Docker toolkit for testing.

Usage:

tux docker test [OPTIONS]

Options:

tux docker up¶

Start Docker services.

Runs docker compose up with various options. In development mode, --watch enables automatic code syncing.

Usage:

tux docker up [OPTIONS]

Options:

tux docs¶

Documentation related commands

Usage:

tux docs [OPTIONS] COMMAND [ARGS]...

Options:

Subcommands

• build: Build documentation site.
• serve: Serve documentation locally.

tux docs build¶

Build documentation site.

Usage:

tux docs build [OPTIONS]

Options:

tux docs serve¶

Serve documentation locally.

Usage:

tux docs serve [OPTIONS]

Options:

tux start¶

Start the Discord bot

Usage:

tux start [OPTIONS]

Options:

tux version¶

Display the current version of Tux

Usage:

tux version [OPTIONS]

Options: