Skip to content

Reference

Complete reference documentation for Tux, including CLI commands, environment variables, configuration options, and technical specifications.

Quick Reference

CLI Reference

Complete command-line interface reference for all Tux commands:

  • Bot Commands - Start bot, version information
  • Database Commands - Migration management, health checks, sequence fixes
  • Testing Commands - Test execution, coverage reports
  • Development Commands - Code quality checks, formatting, linting
  • Documentation Commands - Build, serve, deploy documentation
  • Configuration Commands - Generate and validate configuration

Environment Variables

Auto-generated reference for all environment variables and configuration options:

  • Top-level Variables - BOT_TOKEN, database settings, logging
  • BotInfo - Bot name, prefix, activities
  • BotIntents - Discord gateway intents configuration
  • UserIds - Bot owner and sysadmin IDs
  • StatusRoles - Status role mappings
  • XP Configuration - Leveling system settings
  • External Services - Sentry, GitHub, InfluxDB, and more

Auto-Generated

The environment variables reference is automatically generated from the Config model. To update it, run:

Bash
uv run config generate --format markdown

Technical References

Docker Production Deployment

Reference guide for deploying Tux in production using Docker:

  • Production profile configuration
  • Security features and hardening
  • Image tagging and versioning
  • Advanced configuration options

Versioning System

Semantic Versioning implementation and release process:

  • Version detection and priority
  • Git tagging conventions
  • Docker image versioning
  • Pre-release and build metadata

Coverage

Test coverage information and reporting.

Style Guide

Code style and formatting guidelines.

SBOM

Software Bill of Materials reference.

Renovate

Renovate bot configuration reference.

Listings

Directory listings and structure reference.

API Reference

Source Code Reference

Auto-generated API documentation from source code.