library — Claude Code skill: what it does, how to install
Explains the Faebryk hardware component library structure, _F.py facade generation, and rules for writing modules or traits in atopile.
MIT 1 installs ★ 4,090 updated 2026-10-14
npx skills add atopile/atopile --skill library -a claude-codeWhat library does
This skill guides agents through the Faebryk component library located in src/faebryk/library/. It establishes clear architectural boundaries: components like Resistor or LED represent physical hardware parts derived from Node, while traits like can_bridge represent behavior.
The library exposes its types via the generated barrel file src/faebryk/library/_F.py. Editing this file by hand is pointless because the script tools/library/gen_F.py overwrites it completely, using topological sorting to prevent cyclic import references.
After adding a component file matching its class name, run ato dev test --llm test/library/test_instance_library_modules.py -q to smoke-test instantiation.
What it helps with
- define a new hardware component class inheriting from
Node - add a trait to describe electrical behavior
- regenerate the
_F.pybarrel module without circular imports - run smoke tests for newly added Faebryk library modules
Example prompts for the agent
- Create a new diode component in
src/faebryk/library/following Faebryk conventions - How do I regenerate
_F.pyafter adding a new library module? - Add parameter definitions to this resistor component and run the instance test
How to install library
1Skills CLI (Vercel)
npx skills add atopile/atopile --skill library -a claude-code2Manually: put the files in place
~/.claude/skills/library/SKILL.mdCopy the whole skill folder; for one project use .claude/skills/library/
1Skills CLI (Vercel)
npx skills add atopile/atopile --skill library -a codex2Manually: put the files in place
.agents/skills/library/SKILL.mdFor all projects use ~/.agents/skills/
1Skills CLI (Vercel)
npx skills add atopile/atopile --skill library -a cursor2Manually: put the files in place
.cursor/skills/library/SKILL.mdCursor also reads .agents/skills/ and .claude/skills/
1GitHub CLI
gh skill install atopile/atopile .claude/skills/library2Manually: put the files in place
.github/skills/library/SKILL.md1Skills CLI (Vercel)
npx skills add atopile/atopile --skill library -a gemini-cli2Platform CLI
gemini skills install https://github.com/atopile/atopile --path .claude/skills/libraryManually: put the files in place
.devin/skills/library/SKILL.mdThe legacy .windsurf/skills/ path still works
Skills CLI (Vercel)
npx skills add atopile/atopile --skill library -a opencodeClaude.ai
Zip the folder and upload it in Settings → Capabilities → Skills
Step by step, with commands for each platform: How to install skills in Claude Code: five ways
Questions about library
How do I install library in Claude Code?
Run npx skills add atopile/atopile --skill library -a claude-code in your terminal.
What is the purpose of the library skill?
It provides conventions for extending the atopile Faebryk library, distinguishing traits from components and maintaining the generated _F.py facade.
Why should _F.py not be edited manually?
The generator script tools/library/gen_F.py rebuilds _F.py automatically from all files in src/faebryk/library/, sorting exports to prevent import cycles.
Source text
SKILL.md · MIT
--- name: library description: "How the Faebryk component library is structured, how `_F.py` is generated, and the conventions/invariants for adding new library modules. Use when adding or modifying library components, traits, or module definitions." --- # Library Module The `library` module (located in `src/faebryk/library/`) contains the collection of reusable components, traits, and interfaces that form the "standard library" of the hardware design language. ## Quick Start ```python import faebryk.core.faebrykpy as fbrk import faebryk.core.graph as graph import faebryk.library._F as F g = graph.GraphView.create() tg = fbrk.TypeGraph.create(g=g) resistor = F.Resistor.bind_typegraph(tg=tg).create_instance(g=g) ``` ## Relevant Files - **Facade (auto-generated)**: `src/faebryk/library/_F.py` - Eagerly imports and re-exports library modules/types for the `import faebryk.library._F as F` pattern. - This file is generated; do not hand-edit it. - **Generator**: `tools/library/gen_F.py` - Scans `src/faebryk/library/*.py`, detects whether the file contains a same-named class, and writes `_F.py`. - Orders exports via a topological sort of `F.<Name>` references to avoid import-order cycles. - **Components**: `src/faebryk/library/` contains specific component definitions (e.g. `Resistor.py`, `Capacitor.py`, `LED.py`). - **Traits/Interfaces**: Also contains trait definitions (e.g. `can_bridge.py`, `is_power.py`). ## Dependants (Call Sites) - **User Code**: atopile projects heavily import from `faebryk.library._F` (aliased as `F`). - **Compiler**: The compiler maps `ato` built-ins to these classes. ## How to Work With / Develop / Test ### Core Concepts - **Traits vs Components**: Use Traits for behavior (what it *can do* like `can_bridge`) and Components for physical things (what it *is* like `Resistor`). - **Export model**: `_F.py` is a generated “barrel” module; importing it is intentionally convenient but can be heavyweight. ### Development Workflow 1. **New Component**: Create a new file `MyComponent.py` in `src/faebryk/library/`. Inherit from `Node` (or a more specific base). 2. **Naming Convention**: Class names should match the file basename (usually). 3. **Regenerate `_F.py`**: run `python tools/library/gen_F.py` and commit the updated `src/faebryk/library/_F.py`. ### Testing - Library tests live under `test/library/` (including `test/library/nodes/`). - A good smoke test for new modules is: - `ato dev test --llm test/library/test_instance_library_modules.py -q` ## Best Practices - **Atomic Parts**: Mark leaf components (specifically verified part numbers) with the `is_atomic_part` trait. - **Parameters**: Use `F.Parameters` to define physical properties like `resistance`, `capacitance`, etc. - **Documentation**: Add docstrings to components explaining their ports and parameters.
© atopile · MIT · atopile/atopile