Skip to main content

#Labops - A declarative, YAML-based homelab manager

A declarative, YAML-based homelab manager. labops is a CLI tool that simplifies, automates and standardizes the setup, configuration and maintenance of your homelab infrastructure using simple configuration files and powerful backend automation.

📖 Documentation  ·  Getting started  ·  Configuration  ·  Commands

What it does

You describe your homelab once — the machines, the containers, the services they expose — and labops derives the rest from it.

hosts:
  cprox:
    hypervisor: proxmox
    os: debian
    ip: 10.0.10.3
    lxc:
      pihole:
        ip: 10.0.10.5
        os: debian
        vmid: 105
        web_services:
          - proxy_name: pihole
            port: 8080

That container is now three things at once: something labops update will patch, a pihole.lab DNS record, and a pihole.example.com route in your Caddyfile. Nothing was declared twice, so nothing can drift.

  • Host management — setup and updates across Alpine, Debian and RedHat, via built-in Ansible playbooks
  • Proxmox VMs & LXC — containers driven through the Proxmox host with pct, so they need no sshd
  • Target selection — update an arbitrary slice of the lab by kind, OS, tag or position in the tree, ad-hoc or from a named set
  • Docker stacks — sync compose files to a node, bring them up, pull newer images
  • DNS automation — every node becomes a Pi-hole v6 record, derived from the inventory
  • Reverse proxy — a Caddyfile rendered from your web_services, with access lists and wildcard TLS
  • Wake — a magic packet for bare metal, qm / pct start for a Proxmox guest

Installation

pipx install labops
# or
pip install labops

Since labops is a standalone CLI tool, using pipx is highly recommended to isolate its dependencies.

Usage

Point it at a YAML config and go. labops finds homelab.yml by walking up from your current directory, the way docker compose finds a compose file.

labops --help          # every available command
labops validate        # is the config sound?
labops host list       # what do I have?
labops update --all    # patch everything

→ Full documentation, including a configuration reference and a JSON Schema for editor autocompletion.

Development

See the development guide for the full setup. In short:

uv sync
source .venv/bin/activate

just check      # lint + type-check
just test       # pytest
just docs-serve # preview the docs site

The project uses Dev Containers for a consistent environment and uv for package management. Releases are automated with release-please; the package is published to PyPI by GitHub Actions, not by hand.

Metadata

Release files for labops 0.11.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for labops 0.11.3
File Size Uploaded Provenance Actions
labops-0.11.3.tar.gz 350.7 kB Without provenance Details for labops-0.11.3.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for labops 0.11.3
File Interpreter ABI Platform Actions
labops-0.11.3-py3-none-any.whl Python 3 none any Details for labops-0.11.3-py3-none-any.whl

Total release size: 497.3 kB

Release files / labops-0.11.3.tar.gz

Download URL labops-0.11.3.tar.gz
Size 350.7 kB
Tags Source
SHA-256 checksum
How to use checksums
49a73176f685a5107552fdfa59c91d92341a4a0d8d8b20f2f47ea937d33af2f8
BLAKE2b-256 checksum
How to use checksums
81e569ef3f7db37cd79b51f52078e65d3435c8997a2ee8cfe58e4e3139639817
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.1 {"installer":{"name":"uv","version":"0.13.1","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / labops-0.11.3-py3-none-any.whl

Download URL labops-0.11.3-py3-none-any.whl
Size 146.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
24d25f24c53f92a493544e87fc8b2cc7de51f77ca0f85b548d649c9c24496748
BLAKE2b-256 checksum
How to use checksums
bf08ca48c424d1b8bc228779752270e94f9341b049c07b28612fef6a631cac71
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.1 {"installer":{"name":"uv","version":"0.13.1","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for labops 0.11.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.11.3 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page