Skip to content

nitrosh/nitro-skill

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 

Repository files navigation

nitro-skill

A single SKILL.md that teaches an LLM how to use the nitro Python ecosystem:

Drop it into your assistant's skill directory and the model will know imports, public API, common patterns, and how the pieces compose.

Install

Claude Code

mkdir -p ~/.claude/skills/nitro && \
  curl -fsSL https://raw.githubusercontent.com/nitrosh/nitro-skill/main/SKILL.md \
  -o ~/.claude/skills/nitro/SKILL.md

For project-scoped install (only loads in the current repo):

mkdir -p .claude/skills/nitro && \
  curl -fsSL https://raw.githubusercontent.com/nitrosh/nitro-skill/main/SKILL.md \
  -o .claude/skills/nitro/SKILL.md

Codex / ~/.agents

mkdir -p ~/.agents/skills/nitro && \
  curl -fsSL https://raw.githubusercontent.com/nitrosh/nitro-skill/main/SKILL.md \
  -o ~/.agents/skills/nitro/SKILL.md

Cursor / Windsurf / generic rules file

If your tool reads a single rules file rather than a skills directory, append the contents:

curl -fsSL https://raw.githubusercontent.com/nitrosh/nitro-skill/main/SKILL.md \
  >> .cursorrules

(Replace .cursorrules with .windsurfrules, AGENTS.md, GEMINI.md, etc. as appropriate.)

Manual

Download SKILL.md and put it wherever your assistant looks for skills.

Updating

Re-run the install command. It overwrites the existing file.

What's inside

The skill is one file, around 700 lines. Each package gets its own section with:

  • Install and import (PyPI name vs import name - the two that bite are nitro-ui -> nitro_ui and nitro-image -> nitro_img)
  • Public API surface
  • Common patterns
  • Gotchas worth knowing before you write code

There's also a "How they compose" section showing a real page that uses four of the packages together, and a house-style note (no em-dashes, no emojis, no inline comments unless necessary).

For deep API reference, each package ships its own SKILL.md inside its repo - this file points you there when the surface here isn't enough.

License

BSD 3-Clause. See LICENSE.

About

Single SKILL.md for the nitro Python ecosystem - nitro-cli, nitro-ui, nitro-dispatch, nitro-validator, and nitro-image

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors