Best practices for NetBox API integrations, available for multiple AI coding assistants and human readers.
| Audience | Start Here |
|---|---|
| Engineers | HUMAN.md - Best practices guide |
| Claude Code users | Install skills (see below) |
| Cursor IDE users | Install rules (see below) |
Option 1: npx skills CLI
npx skills add netboxlabs/netbox-best-practicesOption 2: Manual install
# Global (all projects)
cp -r skills/* ~/.claude/skills/
# Or project-local
cp -r skills/* .claude/skills/Copy .cursor/rules/ to your project root:
cp -r .cursor/rules/ /path/to/your/project/.cursor/rules/Rules are auto-applied based on file patterns. See Cursor Rules docs for details.
| Topic | Description |
|---|---|
| netbox-integration-best-practices | REST/GraphQL API integration patterns |
| Format | Location | Description |
|---|---|---|
| Human Documentation | HUMAN.md |
Concise guide for engineers |
| Claude Code Skills | skills/*/SKILL.md |
Progressive disclosure format |
| Cursor Rules | .cursor/rules/*.mdc |
Concise IDE rules |
| Detailed Rules | skills/*/references/rules/ |
Authoritative source |
HUMAN.md provides a concise best practices guide covering all skills. For detailed rationale and exceptions, see the individual rule files in skills/*/references/rules/.
Skills are automatically discovered from the skills/ directory. See CLAUDE.md for maintenance information.
Cursor rules are in the .cursor/rules/ directory and will be automatically applied based on file patterns. See AGENTS.md for a quick reference.