Phoxtail

The engine behind every Phoxtail project.

Phoxtail is a CLI toolkit that automates the development and deployment workflow for Phoxtail projects — Docker configuration, environment setup, database operations, nginx, SSL, media sync, and more.

Requirements

• Python 3.11+
• uv (recommended) or pip

Installation

As a CLI tool

# Recommended: installs in an isolated environment
uv tool install phoxtail

# Or with pip/pipx
pip install phoxtail

For development

git clone git@github.com:phoxmor/phoxtail.git
cd phoxtail
uv venv
source .venv/bin/activate
uv pip install -e ".[dev]"

Usage

Run phoxtail from the root of any Phoxtail project (where phoxtail.toml lives):

phoxtail --help

Commands

Project detection

Phoxtail detects projects by looking for phoxtail.toml in the current directory. This file declares the project name, Docker image prefix, database clusters, and their dependencies.

Development

Running tests

pytest

Project structure

phoxtail/
  phoxtail/
    __init__.py         # Package version
    __main__.py         # CLI entry point (Typer app)
    commands/           # Command modules
    utils/              # Shared utilities (config, docker, env, templates)
    templates/          # Jinja2 templates (Dockerfile, compose, nginx, env)
    tests/              # Test suite
  pyproject.toml
  LICENSE
  README.md

License

BSD 3-Clause. See LICENSE.