What is open-homelab CLAUDE.md?

Project-specific instructions for the open-homelab repository, a template for running a personal home laboratory environment.

They guide local or optional AWS deployment, configuration, DNS, certificates, and safe handling of secrets.

They give contributors the repository's expected documentation order, deployment defaults, and rules for keeping private values out of commits.

How open-homelab-io/open-homelab configures Claude Code

Reuse

Borrowing it

Nothing to install: this file belongs to open-homelab-io/open-homelab. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file

curl -O https://raw.githubusercontent.com/open-homelab-io/open-homelab/main/CLAUDE.md

Clone the repo

git clone --depth 1 https://github.com/open-homelab-io/open-homelab

Made for: Claude Code.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

README.md

[![agentmods](https://agentmods.dev/badge/instructions/open-homelab-io/open-homelab/claude-md/github.svg)](https://agentmods.dev/instructions/open-homelab-io/open-homelab/claude-md)

Your own site

<a href="https://agentmods.dev/instructions/open-homelab-io/open-homelab/claude-md"><img src="https://agentmods.dev/badge/instructions/open-homelab-io/open-homelab/claude-md/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

Your own site · 80×15

<a href="https://agentmods.dev/instructions/open-homelab-io/open-homelab/claude-md"><img src="https://agentmods.dev/badge/instructions/open-homelab-io/open-homelab/claude-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 532 This file is loaded in full into every session.

When invoked 532 The same file — it is already loaded in full.

Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.

Origin original No closer match found in the catalogue.

Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

Model	Per session	Once invoked
Fable 5.1	$0.00532	$0.00532
Opus 5	$0.00266	$0.00266
Sonnet 5	$0.00106	$0.00106
Haiku 4.5	$0.00053	$0.00053

Measured 11d ago against content hash 56aee2401eeb, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-11, from the pricing page.

Security

Grade A, and why

open-homelab CLAUDE.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 11d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

CLAUDE.md · 74 lines

How it starts

The opening of the file, as written. The whole thing — 74 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Claude Guidance

This repo is a public, code-first homelab template. Help users bring it online safely and keep personal lab values out of commits.

Skills

Use repo-local Claude skills when the task matches:

.claude/skills/open-homelab-local-bringup/SKILL.md: default local/no-AWS deployment, bootstrap, validation, and recovery.
.claude/skills/open-homelab-aws-bringup/SKILL.md: optional S3 OpenTofu state, Route53 DNS automation, IAM Roles Anywhere, ExternalDNS, and public ACME certificates.

First Docs To Read

README.md
docs/getting-started.md
docs/deployment-modes.md
docs/configuration.md
docs/operations.md

Deployment Defaults

Default to local/no-AWS unless the user explicitly asks for AWS:

local OpenTofu state
Proxmox VMs
Talos Kubernetes
Cilium
Argo CD default root path: clusters/production/gitops/root
local DNS or /etc/hosts
no Route53, ExternalDNS, IAM Roles Anywhere, or public ACME certificates

AWS is opt-in:

AWS_OPENTOFU_STATE_ENABLED=1 for S3 OpenTofu state
AWS_DNS_AUTOMATION_ENABLED=1 for Route53, IAM Roles Anywhere, ExternalDNS, and DNS-01 certificates
AWS-enabled GitOps path requires ALLOW_AWS_GITOPS=1 GITOPS_ROOT_PATH=clusters/production/gitops

Secret Handling

Never print or commit:

.env
Proxmox API tokens
AWS credentials
Talos secrets.yaml
generated kubeconfigs or talosconfigs
OpenTofu state
OpenBao root tokens, unseal keys, recovery keys, or generated app secrets
IAM Roles Anywhere private keys or certificates

Placeholders such as example.com, [email protected], Z00000000000000000000, and user@pam!token-id=token-secret are documentation examples only.

Validation

Use the narrowest relevant validation:

cd infra/proxmox
bun run typecheck
bun run synth

cd infra/aws
bun run typecheck
bun run synth

kubectl kustomize platform
kubectl kustomize clusters/production/gitops
kubectl kustomize clusters/production/gitops/root

Read the full file on GitHub · 74 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

11d ago First seen · 74 lines · 532 tokens per session scan A 56aee2401eeb

Subscribe to this mod's changes

open-homelab CLAUDE.md is an instructions file published in the GitHub repository open-homelab-io/open-homelab (12 stars, last pushed 1mo ago), licensed Apache-2.0. It adds 532 tokens to every session, about $0.0027 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

next.js AGENTS.md

AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,296 tokens

codex AGENTS.md

AGENTS.md instructions for openai/codex, covering rust/codex-rs, the codex-core crate, code review rules, crate api surface and model visible context.

openai/codex · 5,153 tokens

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 6,785 tokens

open-homelab: Instructions file for Claude Code