Stats
Actions
Available In
Tags
README
trmnl-agent-skills
A template writing agent skill for the TRMNL, packaged for Claude Code, Cursor, OpenAI Codex CLI, Gemini CLI, and GitHub Copilot.
The skill bundles three files copied verbatim from TRMNL's core repo, curated for the external agent context:
| File | What it is |
|---|---|
agent_prompt.md | TRMNL AI assistant agent rules — mandatory workflows, hard rules, common mistakes. Also what TRMNL's MCP server ships as connection-level instructions to external clients. |
template_guide.md | The full TRMNL design system (every framework class, layout, chart pattern; ~2700 lines). |
framework_v3_guide.md | Framework v3 supplement: chromatic palette, CSS variables, label variants. |
Source of truth: skills/trmnl/. Generated outputs (committed for zero-tool install): dist/.
Install
| Harness | Command |
|---|---|
| Claude Code | /plugin marketplace add usetrmnl/trmnl-agent-skills && /plugin install trmnl@trmnl-agent-skills |
| Cursor (2.5+) | Install via symlink for local dev — see install/README.md. |
| OpenAI Codex | drop dist/codex/AGENTS.md into your project root |
| Gemini CLI | drop dist/gemini/GEMINI.md into your project root |
| GitHub Copilot | copy dist/copilot/.github/ into your repo |
Full install: install/README.md.
Develop
bin/sync-from-core # pull latest reference files from TRMNL core (sibling repo)
bin/generate # regenerate dist/ from skills/
Run bin/generate after editing anything under skills/ or after bin/sync-from-core. Commit dist/ alongside source so users without Ruby can install directly.
License
MIT. See LICENSE.
Stats
Version0.1.0
LanguageRuby
Stars0
MaintenanceGood
LicenseMIT
Last Commit
Added
Available In
