How evoveotech/cursor-howto works
1. This repository is a structured learning and reference site for Cursor IDE and Cursor CLI, not an application runtime. Its primary product is content: Markdown tutorials, templates, example configs, and packaged workflows that users copy into their own Cursor setup.
2. The top-level content is organized as a progressive curriculum. The numbered folders 01-slash-commands through 10-cli represent the learning path, moving from user-invoked shortcuts and memory to advanced automation, plugins, and CLI usage. LEARNING-ROADMAP.md, CATALOG.md, and INDEX.md act as the navigation and curriculum index layer.
3. There is a clear boundary between instructional content and reusable artifacts. The instructional layer is the documentation in README.md and module READMEs; the reusable layer is the actual Cursor-facing assets such as slash-command Markdown files, CURSOR.md memory files, skill bundles, subagent definitions, hook scripts, and plugin manifests.
4. The repository models Cursor’s feature stack as separate subsystems: slash commands for explicit user triggers, memory for persistent context, skills for auto-invoked capabilities with scripts/templates, subagents for delegated specialized reasoning, MCP configs for external tool access, hooks for event-driven automation, checkpoints for session rewind, advanced features for planning/background work, and CLI examples for terminal automation.
5. The 03-skills directory is especially important because it contains mixed-content modules: a SKILL.md instruction file plus supporting scripts and templates. That makes it the closest thing in the repo to an executable workflow package, with Python utilities like generate-docs.py, analysis scripts in code-review and refactor, and content templates that drive generated output.
6. The 04-subagents and 05-mcp folders define two different integration boundaries. Subagents partition reasoning into isolated role-specific prompts, while MCP files define machine-readable tool connections to external systems such as GitHub, databases, and the filesystem. These are the repo’s main “agent-to-tool” and “agent-to-agent” integration surfaces.
7. The 06-hooks subsystem provides event-driven automation around Cursor actions. The shell scripts there are intended to run on lifecycle or tool events such as writes, prompts, commits, notifications, and security checks, creating a validation/guardrail layer around the authoring workflow.
8. The 07-plugins folder packages complete solutions as installable bundles. Each plugin combines commands, agents, hooks, templates, and sometimes MCP configs into a cohesive workflow area such as PR review, documentation generation, or DevOps automation. This is the highest-level composition boundary in the repository.
9. 08-checkpoints and 09-advanced-features document stateful and operational features rather than content packages. Checkpoints focus on snapshot/rewind behavior for safe experimentation, while advanced features cover planning mode, permissions, background tasks, and session management. These modules explain how long-running, multi-step work is controlled.
10. The repository also includes a small but important automation backend in scripts/. This Python tooling builds the EPUB export, checks cross-references and links, and validates Mermaid diagrams. It supports the documentation supply chain rather than the Cursor feature content itself.
11. Quality and delivery are enforced through GitHub Actions in .github/workflows/. Separate workflows handle docs checks, release, and tests, while repo metadata like issue templates, PR templates, security reporting, and testing docs define the contribution and verification boundary.
12. The main data flow is: author Markdown/config/script assets in the numbered feature folders, validate them with local Python/shell tooling and CI, then consume them in Cursor by copying or installing them into the user’s Cursor settings, .cursor/ directories, or home-directory configuration. In other words, this repo is a source-of-truth template library plus a documentation system for assembling Cursor workflows.
Main entry points: 07-plugins/README.md Plugins · 03-skills/README.md Skills · scripts/README.md Scripts · README.md README
Components 22
Curriculum
Navigation and learning-path content for the repo
- README · Top-level overview and usage guidance
README.md - Learning roadmap · Progressive path through the numbered modules
LEARNING-ROADMAP.md - Catalog · Inventory of available lessons and assets
CATALOG.md - Index · Cross-reference map for the repository
INDEX.md
Cursor features
Core instructional modules for Cursor capabilities
- Slash commands · Explicit command snippets for common workflows
01-slash-commands/README.md - Memory · CURSOR.md memory files for scoped and project context
02-memory/README.md - Skills · Reusable capability bundles with instructions, scripts, and templates
03-skills/README.md - Code review · Metrics, complexity analysis, and review templates
03-skills/code-review/SKILL.md - Doc generator · Documentation generation workflow with Python automation
03-skills/doc-generator/SKILL.md - Refactor · Smell detection, complexity analysis, and refactoring plans
03-skills/refactor/SKILL.md - Subagents · Role-specific agent prompts for specialized tasks
04-subagents/README.md - MCP configs · Machine-readable connectors to external systems
05-mcp/README.md - Hooks · Lifecycle and guardrail scripts around Cursor actions
06-hooks/README.md - Checkpoints · Snapshot and restore examples for safe experimentation
08-checkpoints/README.md - Advanced features · Planning mode, permissions, background tasks, and session controls
09-advanced-features/README.md - CLI · Cursor CLI usage and examples
10-cli/README.md
Composable packages
Bundles that combine commands, agents, hooks, templates, and configs
- Plugins · Highest-level packaged workflows built from multiple Cursor features
07-plugins/README.md - Docs plugin · Documentation generation and sync workflow package
07-plugins/documentation/README.md - DevOps plugin · Deployment, incident, and rollback workflow package
07-plugins/devops-automation/README.md - PR review plugin · Pull-request review workflow package with checks and review agents
07-plugins/pr-review/README.md
Tooling
Repo automation, validation, and publishing support
- Scripts · Python tooling for EPUB build, validation, and link checking
scripts/README.md
Governance
Contribution, release, and quality boundaries
- GitHub Actions · Docs checks, release, and test automation
.github/workflows/docs-check.yml
Connections 23
- README → Learning roadmap: orients · Introduces the learning path and repository structure
- README → Catalog: summarizes · Points readers to the inventory of lessons and assets
- README → Index: maps · Uses the index as a navigation layer
- Learning roadmap → Slash commands: starts with · Curriculum begins with explicit user commands
- Learning roadmap → CLI: ends with · Curriculum culminates in terminal automation
- Index → Memory: references · Maps feature modules and reusable assets
- Slash commands → Memory: feeds · Commands are used alongside persistent context
- Memory → Skills: supports · Context files help package reusable workflows
- Skills → Code review: includes · Representative skill module
- Skills → Doc generator: includes · Representative skill module
- Skills → Refactor: includes · Representative skill module
- Refactor → Scripts: uses · Skill depends on analysis utilities
- Code review → Scripts: uses · Skill depends on metrics and comparison scripts
- Subagents → Plugins: composes into · Subagent roles are packaged into higher-level solutions
- MCP configs → Plugins: composes into · Tool integrations are bundled into plugins
- Hooks → Plugins: composes into · Event scripts are packaged with workflows
- Plugins → Docs plugin: contains · Documentation-focused workflow bundle
- Plugins → DevOps plugin: contains · Operations-focused workflow bundle
- Plugins → PR review plugin: contains · Review-focused workflow bundle
- Checkpoints → Advanced features: pairs with · State management and operational controls are adjacent topics
- Scripts → GitHub Actions: validated by · Local automation is reinforced by workflow checks
- GitHub Actions → Catalog: checks · CI helps keep docs and references consistent
- GitHub Actions → Scripts: runs · Workflows execute repository validation and build tooling