nix-ai: Instructions file for GitHub Copilot

.github/copilot-instructions.md

nix-ai copilot-instructions.md is an instructions file for GitHub Copilot from dryvist/nix-ai. It costs 476 tokens per session, scanned B, original, MIT.

A contributor guide for nix-ai, an ecosystem of AI command-line tools and MCP servers packaged as Nix home-manager modules. It explains the project’s Nix constraints, validation checks, and rebuild process.

In plain words
What is it for?
Use it when changing Nix modules, plugins, hooks, settings, activations, or MCP servers, and when running formatting, checks, or a nix-darwin rebuild.
Why use it?
It prevents contributors from using unsupported imperative Nix commands or wiring module inputs incorrectly. It also distinguishes static checks from the rebuild and fresh session needed to verify runtime changes.

Instructions file for GitHub Copilot

Written for GitHub Copilot: a Copilot instructions file. Also seen: mentions CLAUDE.md; mentions Claude Code; mentions Codex.

This is dryvist/nix-ai's own configuration. It tells GitHub Copilot how to work on nix-ai itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything nix-ai configures →

Reuse

Borrowing it

Nothing to install: this file belongs to dryvist/nix-ai. 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/dryvist/nix-ai/develop/.github/copilot-instructions.md
Clone the repo
git clone --depth 1 https://github.com/dryvist/nix-ai

Made for: GitHub Copilot.

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.

agentmods badge for nix-ai copilot-instructions.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/dryvist/nix-ai/copilot-instructions/github.svg)](https://agentmods.dev/instructions/dryvist/nix-ai/copilot-instructions)
Your own site
<a href="https://agentmods.dev/instructions/dryvist/nix-ai/copilot-instructions"><img src="https://agentmods.dev/badge/instructions/dryvist/nix-ai/copilot-instructions/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.

agentmods 80×15 button for nix-ai copilot-instructions.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/dryvist/nix-ai/copilot-instructions"><img src="https://agentmods.dev/badge/instructions/dryvist/nix-ai/copilot-instructions.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 476 This file is loaded in full into every session.
When invoked 476 The same file — it is already loaded in full.
Security scan B 1 finding. 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.

ModelPer sessionOnce invoked
Fable 5.1 $0.00476 $0.00476
Opus 5.5 $0.00190 $0.00190
Sonnet 5.5 $0.00095 $0.00095
Haiku 4.5 $0.00048 $0.00048

Measured 25d ago against content hash edd8f484185e, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade B, and why

nix-ai copilot-instructions.md scanned grade B with 1 finding 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 25d 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.

Asks for rootmediumPrivilege escalation

A mod that escalates privileges can change anything on the machine, not only the project.

sudo darwin-rebuild switch --flake "$HOME/git/nix-darwin/main" \
.github/copilot-instructions.md · 53 lines

What it actually says

GitHub Copilot Instructions — nix-ai

Repository Purpose

nix-ai is an AI CLI ecosystem (Claude Code, Antigravity, Codex, Copilot, MCP servers, MLX inference) delivered as Nix home-manager modules. It exports modules consumed by nix-darwin; this repo holds the module definitions, not a deployed system.

Critical Constraints

  • Flakes-only. Never generate nix-env or other imperative Nix commands.
  • Module args injection. Flake inputs reach modules via _module.args, not function parameters.
  • No direct main commits. Always work on a feature branch in a worktree.

Validation

Static checks run on every change:

nix flake check    # formatting, statix, deadnix, regression tests
nix fmt            # auto-fix formatting

Runtime changes (plugins, hooks, settings, activations, MCP servers) also need a real rebuild and a fresh Claude Code session — static checks validate Nix evaluation, not runtime behavior:

sudo darwin-rebuild switch --flake "$HOME/git/nix-darwin/main" \
  --override-input nix-ai "$HOME/git/nix-ai/<worktree>"

Conventions

  • Scripts longer than a few lines live in scripts/*.sh, never inline in .nix.
  • Never hardcode model IDs, endpoints, or version strings — read them from vars/ai-stack.nix (the central registry).
  • Never put secrets in Nix expressions or env: blocks; they end up in the world-readable Nix store. Use Doppler or the macOS Keychain.

Key Files

  • modules/default.nix — module entry point
  • modules/mcp/catalog.nix — shared MCP server catalog
  • modules/mlx/ — local Apple Silicon inference (mlx_lm.server LaunchAgent)
  • vars/ai-stack.nix — model/endpoint/version registry
  • lib/checks/ — per-domain regression tests

See CLAUDE.md and docs/architecture/ for the full architecture.

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.

  1. 25d ago Changed · -1 tokens per session edd8f484185e
  2. 1mo ago First seen · 53 lines · 477 tokens per session scan B 6c536952bcfa

Subscribe to this mod's changes

nix-ai copilot-instructions.md is an instructions file published in the GitHub repository dryvist/nix-ai (11 stars, last pushed today), licensed MIT. It adds 476 tokens to every session, about $0.0019 per session on Opus 5.5. A static security scan graded it B with 1 finding (asks for root). No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

Other instructions, from other repositories

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 · 9,715 tokens

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,461 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, cache eligibility and rollout and applying the notice (cutover).

microsoft/vscode · 5,262 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,680 tokens

vscode copilot-instructions.md

Copilot instructions for microsoft/vscode, covering vs code copilot instructions, project overview, root folders, core architecture (src/ folder) and built-in extensions (extensions/ folder).

microsoft/vscode · 2,731 tokens

deno copilot-instructions.md

Copilot instructions for denoland/deno, covering deno development guide for github copilot, network access, high level overview, key directories and key files to understand first.

denoland/deno · 3,077 tokens