https://github.com/cevr/primer
CLI that renders curated markdown instructions for AI agents
https://github.com/cevr/primer
Last synced: 5 months ago
JSON representation
CLI that renders curated markdown instructions for AI agents
- Host: GitHub
- URL: https://github.com/cevr/primer
- Owner: cevr
- Created: 2026-01-19T22:01:54.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2026-01-20T02:16:38.000Z (5 months ago)
- Last Synced: 2026-01-20T08:56:01.877Z (5 months ago)
- Language: TypeScript
- Size: 62.5 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# Primer
Curated markdown primers for AI agents.
## Installation
```bash
bun add -g @cvr/primer
primer init # Install skill file for AI tools
```
## Usage
```bash
primer # List available primers
primer effect # Render a primer
primer effect services # Render a sub-primer
primer help # Show help with examples
```
## What is a Primer?
A primer is curated markdown that teaches AI agents _how to do things well_. Unlike templates that generate boilerplate, primers provide context, patterns, and step-by-step guidance.
**Example use cases:**
- `primer effect` before writing Effect TypeScript code
- `primer cli` when building a command-line tool
- `primer oxlint` when setting up linting
## Architecture
```
primer CLI
│
├─ ManifestService ──→ _manifest.json (primer registry)
│
└─ PrimerCache ──→ ~/.primer/ (local cache, background refresh)
│
└──→ GitHub raw (primers/)
```
**Primer structure:** Each primer is a directory with `index.md` (main) + optional sub-primers. Sub-primers accessed via `primer `.
## AI Tool Integration
Run `primer init` to install skill files:
| Tool | Location |
| ----------- | ------------------------------------------- |
| Claude Code | `~/.claude/skills/primer.md` |
| Cursor | `~/.cursor/skills/primer.md` |
| OpenCode | `~/.config/opencode/skills/primer/SKILL.md` |
Use `primer init --local` for project-level installation.
## Development
```bash
git clone https://github.com/cevr/primer.git
cd primer && bun install
bun run dev effect # Run locally
bun run check # Typecheck + lint + format
bun run test # Run tests
```
## License
MIT