skills.rest
khaneliman
khanelimanCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

scaffolding-modules

Organize Nix module scaffolding into a standardized layout with frontmatter validation.

340|18|Updated May 11, 2023
Search Tags:#documentation#scaffolding#nix#modules#nixos#home-manager
One-click install
npx skills add https://github.com/khaneliman/khanelinix --skill scaffolding-modules
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: scaffolding-modules
Source: https://github.com/khaneliman/khanelinix/tree/main/modules/common/ai-tools/skills/scaffolding-modules
Command: npx skills add https://github.com/khaneliman/khanelinix --skill scaffolding-modules

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Creating consistent module layouts and auto-discovery guidance for Nix-based configurations, reducing guesswork when organizing platform-specific modules.

Core Features & Use Cases

  • Provides a standardized directory structure for nixos, darwin, home managers, and shared modules.
  • Helps new contributors place files correctly and understand module placement rules.
  • Use case: when starting a new project, apply the scaffolding to set up folders and templates, ensuring maintainability.

Quick Start

Copy the scaffolding template into your target modules/ directory and customize its metadata and layout.

Frequently Asked Questions about scaffolding-modules

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I standardize NixOS module layout for auto-discovery?▼

Standardizing NixOS module layout involves applying scaffolding templates that enforce consistent directory placement and frontmatter metadata. This enables auto-discovery for nixos, darwin, and home-manager modules while reducing structural guesswork during project setup.

What is the required frontmatter for a Nix module to be discovered?▼

Required frontmatter for Nix module discovery includes name and description fields. Adhering to these frontmatter requirements ensures the module is correctly discovered and its metadata is enriched when the scaffolding structure is applied.

Can I use this scaffolding for both home-manager and darwin configurations?▼

Yes, this scaffolding supports both home-manager and darwin configurations. It provides a standardized directory structure that explicitly accommodates nixos, darwin, home-manager, and shared common modules for consistent placement.

How do I organize shared Nix modules alongside platform-specific ones?▼

Organize shared Nix modules by placing them in the designated common modules directory provided by the scaffolding. This separates them from platform-specific nixos, darwin, and home-manager directories while maintaining consistent auto-discovery.

What's the best way to structure Nix module directories for new contributors?▼

The best way to structure Nix module directories for new contributors is applying a standardized scaffolding layout. This helps them place files correctly, understand placement rules, and ensures project maintainability through clear documentation and templates.

Related Skills

Explore More Software Engineering Skills→
DoeringChristianDoeringChristian

nix-flake-guide

Explain basic Nix flake creation, structure, inputs, outputs, and development shells.

Community
Basic
YParesYPares
84

Nix Module System

Explain nix module management, troubleshooting, and composition best practices.

Community
Advanced
JylhisJylhis
1

home-manager

Automate Home Manager configurations across NixOS, nix-darwin, and flake-based setups.

Community
Intermediate
acefrost511acefrost511

github-to-skills

Convert a GitHub repository into a standardized AI skill with SKILL.md frontmatter.

Community
Advanced