Archived
0
0
Fork
You've already forked tux
0
Archive of github.com/allthingslinux/tux up to 24 Apr 2026
This repository has been archived on 2026年05月01日. You can view files and clone it, but you cannot make any changes to its state, such as pushing and creating new issues, pull requests or comments.
  • Python 99.1%
  • Shell 0.4%
  • Dockerfile 0.3%
  • PHP 0.1%
renovate[bot] 0e5165e3d9
 chore(deps): update dev [skip pre-commit.ci] ( #1230 ) 
| datasource | package | from | to |
| ---------- | ------------ | ------ | ------- |
| pypi | basedpyright | 1.38.3 | 1.39.2 |
| pypi | ruff | 0.15.6 | 0.15.11 |
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2026年04月24日 05:39:14 +00:00
.agents docs: sync error handling and repository layout 2026年04月17日 16:42:03 -04:00
.cursor chore: extend gitignore for local tooling 2026年04月17日 16:42:08 -04:00
.devcontainer chore(deps): update mcr.microsoft.com/devcontainers/python docker tag to v2 2025年12月03日 10:47:37 -05:00
.github chore(deps): update actions [skip pre-commit.ci] ( #1248 ) 2026年04月18日 13:04:47 +00:00
.vscode fix(vscode): disable markdown validation in settings 2026年01月09日 17:48:44 -05:00
assets feat(branding): add help banner image 2026年01月23日 05:15:39 -05:00
config feat(env): add Valkey configuration options and update example files 2026年01月29日 15:04:07 -05:00
docker fix(docker): resolve TLDR cache permission denied on fresh systems 2026年04月06日 11:35:46 -04:00
docs docs: sync error handling and repository layout 2026年04月17日 16:42:03 -04:00
scripts feat(database): add configurable connection pool settings to prevent exhaustion 2026年03月08日 10:53:39 -04:00
src/tux fix(permissions): fix decorator order on levels and config subcommands 2026年04月18日 11:55:34 -04:00
tests refactor(shared): split exceptions into package and adopt gather helpers 2026年04月17日 16:41:52 -04:00
typings chore: remove unused type stub files for pydantic_settings_export 2026年01月21日 01:57:58 -05:00
.commitlintrc.json feat: enhance CLI options for database and development commands 2025年11月10日 15:52:17 -05:00
.cursorignore chore: add .cursorignore and update .gitignore and .markdownlintignore 2026年01月21日 01:58:19 -05:00
.dockerignore chore(docker): remove production compose file from .dockerignore 2026年01月21日 13:56:18 -05:00
.docstr.yaml chore: remove unused configuration files and update versioning 2025年11月10日 15:53:05 -05:00
.editorconfig chore: enhance shell script formatting and linting configuration 2025年12月01日 15:17:11 -05:00
.env.example feat(database): add configurable connection pool settings to prevent exhaustion 2026年03月08日 10:53:39 -04:00
.git-blame-ignore-revs chore: add formatting commit to blame ignore list 2025年11月24日 01:31:17 -05:00
.gitignore chore(gitignore): add GREENFIELD.md to .gitignore 2026年04月18日 06:53:38 -04:00
.markdownlint.yaml docs(markdownlint): update configuration for heading rules 2026年01月09日 17:37:31 -05:00
.markdownlintignore chore: add .cursorignore and update .gitignore and .markdownlintignore 2026年01月21日 01:58:19 -05:00
.pre-commit-config.yaml chore: update pre-commit hook versions ( #1176 ) 2026年02月14日 13:27:57 -05:00
.python-version chore(deps): update Python version to 3.13.11 in configuration files 2026年01月23日 05:15:39 -05:00
.yamllint.yml chore(yamllint): update configuration to enforce minimum space from content to comments 2025年12月05日 22:38:41 -05:00
AGENTS.md docs: update AGENTS.md and add CLI command references 2026年03月27日 16:22:25 -04:00
alembic.ini refactor: standardize ID field naming across models and controllers 2025年10月22日 02:37:01 -04:00
CHANGELOG.md perf: in-memory XP cooldown, get_context pre-filter, AFK cache, lazy=noload 2026年04月18日 06:14:08 -04:00
codecov.yml chore: update Codecov configuration to change informational status 2025年12月03日 05:50:50 -05:00
compose.yaml chore(deps): update docker [skip pre-commit.ci] ( #1249 ) 2026年04月21日 14:06:30 +00:00
Containerfile chore(container): simplify Python image reference in Containerfile 2026年01月23日 05:15:39 -05:00
flake.lock chore(deps): lock file maintenance [skip pre-commit.ci] ( #1250 ) 2026年04月21日 14:06:55 +00:00
flake.nix chore(flake): simplify project description in flake.nix 2025年10月22日 19:59:13 -04:00
LICENSE docs(license): add GNU General Public License v3.0 2025年06月15日 04:45:46 -04:00
mise.toml chore(deps): update Python version to 3.13.11 in configuration files 2026年01月23日 05:15:39 -05:00
pyproject.toml chore(deps): update dev [skip pre-commit.ci] ( #1230 ) 2026年04月24日 05:39:14 +00:00
README.md Update README to remove fake claims 2026年02月14日 13:04:40 -05:00
ROADMAP.md chore: update CHANGELOG and add ROADMAP document 2025年11月24日 15:02:58 -05:00
shell.nix feat: migrate from poetry to uv 2025年07月22日 19:45:46 -04:00
TODO.md docs(todo): add task to fix debug logging issue in docker dev profile 2026年02月03日 07:25:53 -05:00
uv.lock chore(deps): update dev [skip pre-commit.ci] ( #1230 ) 2026年04月24日 05:39:14 +00:00
wrangler.toml feat: add Cloudflare Workers configuration for documentation deployment 2025年12月02日 00:41:38 -05:00
zensical.toml docs: update page icons ( #1174 ) 2026年01月25日 14:20:08 -05:00

Banner

Tux

The all-in-one open source Discord bot

📚 Docs • ❓ FAQ • 💬 Discord • 🗺️ Roadmap

Warning

This codebase is under heavy development and subject to breaking changes. APIs, configurations, and features may change without notice. Documentation is not guaranteed to be accurate or up to date. Use at your own risk in production environments.

Quick Start

Choose your path to get started with Tux:

Role Get Started
👤 Users Get Started
⚙️ Admins Get Started
🐳 Self-Hosters Get Started
💻 Developers Get Started

About

Tux is a feature-rich Discord bot originally built for the All Things Linux community. It provides moderation tools, leveling systems, snippets, utilities, and fun commands - all in one package.

Key Features:

  • Moderation - Comprehensive moderation tools with case management
  • Leveling - XP and ranking system to reward active members
  • Snippets - Quick text responses and custom commands
  • Utilities - Server management and utility commands
  • Fun - Entertainment commands and interactive features
  • Plugin System - Extensible architecture for custom functionality
  • Caching - Optional Valkey (Redis-compatible) cache for guild config, jail status, and permissions; falls back to in-memory TTL when Valkey is not configured

Why Tux?

  • Modern tech stack - Type-safe, async-first, powered by Python 3.13+ and discord.py
  • Production-ready - Battle-tested in large communities with comprehensive error handling
  • Developer-friendly - Clean architecture, extensive docs, and active development
  • Free and open source - Free to use, modify, and contribute under GPL-3.0

Tech Stack

Component Technology
Runtime Python 3.13+ with discord.py
Package Manager uv for fast dependency management
Database PostgreSQL with SQLModel (SQLAlchemy + Pydantic)
Type Safety basedpyright with strict type hints
Code Quality ruff for linting and formatting
Testing pytest with async support
CLI typer with custom command scripts
Logging loguru for structured logging
Monitoring sentry-sdk for error tracking
HTTP Client httpx for async requests
Configuration pydantic-settings with json/env support
Containers Docker & Docker Compose
Cache valkey with in-memory fallback

Documentation

Visit tux.atl.dev for complete documentation including:

Support & Community

Developer Resources:

Getting Started Development Workflow Quality & Standards
Developer Setup Git Best Practices Testing Guide
First Contribution Branch Naming Code Review
Project Structure Creating Commands Error Handling

Project Stats

Metrics

Contributors

Contributors

License

Tux is free and open source software licensed under the GNU General Public License v3.0.

Created by @kzndotsh • Maintained by the All Things Linux community