pencil-design

chiroro-jr/pencil-design-skill · updated May 31, 2026

MDX-style export adds YAML metadata + attribution linking explainx.ai and this canonical listing URL.

$npx skills add https://github.com/chiroro-jr/pencil-design-skill --skill pencil-design
0 commentsdiscussion
summary

Design production UIs in Pencil and generate clean code from design files.

  • Enforces design system reuse, variable-driven styling, and layout correctness to prevent inconsistent, unmaintainable designs
  • Supports design-to-code workflows for React, Next.js, Vue, Svelte, and HTML/CSS with Tailwind v4 semantic classes and shadcn/ui component mapping
  • Requires visual verification after each section via screenshots and layout snapshots to catch overflow, alignment, and spacing issues before
skill.md

Pencil Design Skill

Design production-quality UIs in Pencil and generate clean, maintainable code from them. This skill enforces best practices for design system reuse, variable usage, layout correctness, visual verification, and design-to-code workflows.

When to Use This Skill

  • Designing screens, pages, or components in a .pen file
  • Generating code (React, Next.js, Vue, Svelte, HTML/CSS) from Pencil designs
  • Building or extending a design system in Pencil
  • Syncing design tokens between Pencil and code (Tailwind v4 @theme, shadcn/ui tokens)
  • Importing existing code into Pencil designs
  • Working with any Pencil MCP tools (pencil_batch_design, pencil_batch_get, etc.)

Critical Rules

These rules address the most common agent mistakes. Violating them produces designs that are inconsistent, hard to maintain, and generate poor code.

Rule 1: Always Reuse Design System Components

NEVER recreate a component from scratch when one already exists in the design file.

Before inserting any element, you MUST:

  1. Call pencil_batch_get with patterns: [{ reusable: true }] to list all available reusable components
  2. Search the results for a component that matches what you need (button, card, input, nav, etc.)
  3. If a match exists, insert it as a ref instance using I(parent, { type: "ref", ref: "<componentId>" })
  4. Customize the instance by updating its descendants with U(instanceId + "/childId", { ... })
  5. Only create a new component from scratch if no suitable reusable component exists

See references/design-system-components.md for detailed workflow.

Rule 2: Always Use Variables Instead of Hardcoded Values

NEVER hardcode colors, border radius, spacing, or typography values when variables exist.

Before applying any style value, you MUST:

  1. Call pencil_get_variables to read all defined design tokens
  2. Map your intended values to existing variables (e.g., use primary not #3b82f6, use radius-md not 6)
  3. Apply values using variable references, not raw values
  4. When generating code, use Tailwind v4 semantic utility classes (e.g., bg-primary, text-foreground, rounded-md). NEVER use arbitrary value syntax (bg-[#3b82f6], text-[var(--primary)], rounded-[6px])

See references/variables-and-tokens.md for detailed workflow.

Rule 3: Prevent Text and Content Overflow

NEVER allow text or child elements to overflow their parent or the artboard.

For every text element and container:

  1. Set appropriate text wrapping and truncation
  2. Constrain widths to parent bounds, especially on mobile screens (typically 375px wide)
  3. Use "fill_container" for width on text elements inside auto-layout frames
  4. After inserting content, call pencil_snapshot_layout with problemsOnly: true to detect clipping/overflow
  5. Fix any reported issues before proceeding

See references/layout-and-text-overflow.md for detailed workflow.

Rule 4: Visually Verify Every Section

NEVER skip visual verification after building a section or screen.

After completing each logical section (header, hero, sidebar, form, card grid, etc.):

  1. Call pencil_get_screenshot on the section or full screen node
  2. Analyze the screenshot for: alignment issues, spacing inconsistencies, text overflow, visual glitches, missing content
  3. Call pencil_snapshot_layout with problemsOnly: true to catch clipping and overlap
  4. Fix any issues found before moving to the next section
  5. Take a final full-screen screenshot when the entire design is complete

See references/visual-verification.md for detailed workflow.

Rule 5: Reuse Existing Assets (Logos, Icons, Images)

NEVER generate a new logo or duplicate asset when one already exists in the document.

Before generating any image or logo:

  1. Call pencil_batch_get and search for existing image/logo nodes by name pattern (e.g., patterns: [{ name: "logo|brand|icon" }])
  2. If a matching asset exists elsewhere in the document (another artboard/screen), copy it using the C() (Copy) operation
  3. Only use the G() (Generate) operation for genuinely new images that don't exist anywhere in the document
  4. For logos specifically: always copy from an existing instance, never regenerate

See references/asset-reuse.md for detailed workflow.

Rule 6: Always Load the frontend-design Skill

NEVER design in Pencil or generate code from Pencil without first loading the frontend-design skill.

The frontend-design skill provides the aesthetic direction and design quality standards that prevent generic, cookie-cutter UI. You MUST:

  1. Load the frontend-design skill at the start of any Pencil design or code generation task
  2. Follow its design thinking process: understand purpose, commit to a bold aesthetic direction, consider differentiation
  3. Apply its guidelines on typography, color, motion, spatial composition, and visual details — both when designing in Pencil and when generating code from Pencil designs
  4. Never produce generic AI aesthetics (overused fonts, cliched color schemes, predictable layouts)

This applies to both directions:

  • Pencil design tasks: Use the skill's aesthetic guidelines to inform layout, typography, color, and composition choices in the .pen file
  • Code generation from Pencil: Use the skill's guidelines to ensure the generated code includes distinctive typography, intentional color themes, motion/animations, and polished visual details — not just a mechanical translation of the design tree

Design Workflow

Starting a New Design

0. Load `frontend-design` skill   -> Get aesthetic direction and design quality standards
1. pencil_get_editor_state        -> Understand file state, get schema
2. pencil_batch_get (reusable)    -> Discover design system components
3. pencil_get_variables           -> Read design tokens
4. pencil_get_guidelines          -> Get relevant design rules
5. pencil_get_style_guide_tags    -> (optional) Get style inspiration
6. pencil_get_style_guide         -> (optional) Apply style direction
7. pencil_find_empty_space_on_canvas -> Find space for new screen
8. pencil_batch_design            -> Build the design (section by section)
9. pencil_get_screenshot          -> Verify each section visually
10. pencil_snapshot_layout        -> Check for layout problems

Building Section by Section

For each section of a screen (header, content area, footer, sidebar, etc.):

  1. Plan - Identify which design system components to reuse
  2. Build - Insert components as ref instances, apply variables for styles
  3. Verify - Screenshot the section + check layout for problems
  4. Fix - Address any overflow, alignment, or spacing issues
  5. Proceed - Move to the next section only after verification passes

Design-to-Code Workflow

See references/design-to-code-workflow.md for the complete workflow. See references/tailwind-shadcn-mapping.md for the full Pencil-to-Tailwind mapping table. See references/responsive-breakpoints.md for multi-artboard responsive code generation.

Summary:

  1. Load the frontend-design skill for aesthetic direction
  2. Call pencil_get_guidelines with topic "code" and "tailwind"
  3. Call pencil_get_variables to map design tokens to Tailwind @theme declarations
  4. Read the design tree with pencil_batch_get
  5. Map reusable Pencil components to shadcn/ui components (Button, Card, Input, etc.)
  6. Generate code using semantic Tailwind classes (bg-primary, rounded-md), never arbitrary values
  7. Apply frontend-design guidelines: distinctive typography, intentional color, motion, spatial composition
  8. Use CVA for custom component variants, cn() for class merging, Lucide for icons

MCP Tool Quick Reference

Tool When to Use
pencil_get_editor_state First call - understand file state and get .pen schema
pencil_batch_get Read nodes, search for components (reusable: true), inspect structure
pencil_batch_design Insert, copy, update, replace, move, delete elements; generate images
pencil_get_variables Read design tokens (colors, radius, spacing, fonts)
pencil_set_variables Create or update design tokens
pencil_get_screenshot Visual verification of any node
pencil_snapshot_layout Detect clipping, overflow, overlapping elements
pencil_get_guidelines Get design rules for: code, table, tailwind, landing-page, design-system
pencil_find_empty_space_on_canvas Find space for new screens/frames
pencil_get_style_guide_tags Browse available style directions
pencil_get_style_guide Get specific style inspiration
pencil_search_all_unique_properties Audit property values across the document
pencil_replace_all_matching_properties Bulk update properties (e.g., swap colors)
pencil_open_document Open a .pen file or create a new document

Common Mistakes to Avoid

Mistake Correct Approach
Creating a button from scratch Search for existing button component, insert as ref
Using fill: "#3b82f6" Use the variable: reference primary or the corresponding variable
Using cornerRadius: 8 Use the variable: reference radius-md or the corresponding variable
Generating bg-[#3b82f6] in code Use semantic Tailwind class: bg-primary
Generating text-[var(--primary)] in code Use semantic Tailwind class: text-primary
Generating rounded-[6px] in code Use semantic Tailwind class: rounded-md
Using var(--primary) in className Use semantic Tailwind class: bg-primary or text-primary
Not checking for overflow Call pencil_snapshot_layout(problemsOnly: true) after every section
Skipping screenshots Call pencil_get_screenshot after every section
Generating a new logo Copy existing logo from another artboard with C()
Building entire screen, then checking Build and verify section by section
Ignoring pencil_get_guidelines Always call it for the relevant topic before starting
Using tailwind.config.ts Use CSS @theme block (Tailwind v4)
Using Material Icons in code Map to Lucide icons (<Search />, <ArrowRight />, etc.)
Skipping frontend-design skill Always load it before designing in Pencil or generating code
Generic AI aesthetics (Inter font, purple gradients) Follow frontend-design guidelines for distinctive, intentional design

Resources

how to use pencil-design

How to use pencil-design on Cursor

AI-first code editor with Composer

1

Prerequisites

Before installing skills in Cursor, ensure your development environment meets these requirements:

  • Cursor installed and configured on your development machine
  • Node.js version 16.0+ with npm package manager (verify with node --version)
  • Active project directory or workspace where you want to add pencil-design
2

Execute installation command

Execute the skills CLI command in your project's root directory to begin installation:

$npx skills add https://github.com/chiroro-jr/pencil-design-skill --skill pencil-design

The skills CLI fetches pencil-design from GitHub repository chiroro-jr/pencil-design-skill and configures it for Cursor.

3

Select Cursor when prompted

The CLI will show a list of available agents. Use arrow keys to navigate and space to select Cursor:

◆ Which agents do you want to install to?
│ ── Universal (.agents/skills) ── always included ────
│ • Amp
│ • Antigravity
│ • Cline
│ • Codex
│ ●Cursor(selected)
│ • Cursor
│ • Windsurf
4

Verify installation

Confirm successful installation by checking the skill directory location:

.cursor/skills/pencil-design

Reload or restart Cursor to activate pencil-design. Access the skill through slash commands (e.g., /pencil-design) or your agent's skill management interface.

Security & Verification Notice

We perform automated surface-level scans (Gen AI Scanner, Socket, Snyk) during installation. These checks detect common vulnerabilities but do not guarantee complete security. Always review skill source code and verify the publisher's reputation before production use.

Skills execute code in your development environment. Always verify the publisher's identity, review recent commits, and test in isolated environments before production deployment.

List & Monetize Your Skill

Submit your Claude Code skill and start earning

GET_STARTED →

Use Cases

Task Automation & Efficiency

Automate repetitive workflows and reduce manual effort

Example

Generate reports, summarize documents, draft communications

Save 3-5 hours per week on routine tasks

Knowledge Enhancement

Learn new skills, understand complex topics, get expert guidance

Example

Explain concepts, provide examples, suggest learning resources

Accelerate learning and skill development by 2x

Quality Improvement

Enhance output quality through reviews, suggestions, and refinements

Example

Review drafts, suggest improvements, catch errors

Improve work quality by 30-40% with less effort

Implementation Guide

Prerequisites

  • Claude Desktop or compatible AI client with skill support
  • Clear understanding of task or problem to solve
  • Willingness to iterate and refine outputs

Time Estimate

15-45 minutes depending on use case complexity

Installation Steps

  1. 1.Install skill using provided installation command
  2. 2.Test with simple use case relevant to your work
  3. 3.Evaluate output quality and relevance
  4. 4.Iterate on prompts to improve results
  5. 5.Integrate into regular workflow if valuable

Common Pitfalls

  • Expecting perfect results without iteration
  • Not providing enough context in prompts
  • Using skill for tasks outside its intended scope
  • Accepting outputs without review and validation

Best Practices

✓ Do

  • +Start with clear, specific prompts
  • +Provide relevant context and constraints
  • +Review and refine all outputs before using
  • +Iterate to improve output quality
  • +Document successful prompt patterns

✗ Don't

  • Don't use without understanding skill limitations
  • Don't skip validation of outputs
  • Don't share sensitive information in prompts
  • Don't expect skill to replace human judgment

💡 Pro Tips

  • Be specific about desired format and style
  • Ask for multiple options to choose from
  • Request explanations to understand reasoning
  • Combine AI efficiency with human expertise

When to Use This

✓ Use When

Use when skill capabilities match your task, clear ROI on time saved, and you can validate outputs. Best for repetitive tasks, learning, and quality improvement.

✗ Avoid When

Avoid when task requires deep expertise you can't validate, involves sensitive decisions, or when learning process is more valuable than speed of completion.

Learning Path

  1. 1Familiarize yourself with skill capabilities and limitations
  2. 2Start with low-risk, non-critical tasks
  3. 3Progress to more complex and valuable use cases
  4. 4Build expertise through regular use and experimentation

Discussion

Product Hunt–style comments (not star reviews)
  • No comments yet — start the thread.
general reviews

Ratings

4.671 reviews
  • Aisha Farah· Dec 28, 2024

    I recommend pencil-design for anyone iterating fast on agent tooling; clear intent and a small, reviewable surface area.

  • Anika Lopez· Dec 28, 2024

    pencil-design reduced setup friction for our internal harness; good balance of opinion and flexibility.

  • Olivia Malhotra· Dec 24, 2024

    pencil-design has been reliable in day-to-day use. Documentation quality is above average for community skills.

  • Emma Jackson· Dec 16, 2024

    pencil-design fits our agent workflows well — practical, well scoped, and easy to wire into existing repos.

  • Layla Sharma· Dec 16, 2024

    pencil-design has been reliable in day-to-day use. Documentation quality is above average for community skills.

  • Anika Perez· Dec 12, 2024

    I recommend pencil-design for anyone iterating fast on agent tooling; clear intent and a small, reviewable surface area.

  • Chaitanya Patil· Dec 8, 2024

    We added pencil-design from the explainx registry; install was straightforward and the SKILL.md answered most questions upfront.

  • Anaya Abbas· Dec 8, 2024

    We added pencil-design from the explainx registry; install was straightforward and the SKILL.md answered most questions upfront.

  • Anaya Gonzalez· Dec 4, 2024

    Keeps context tight: pencil-design is the kind of skill you can hand to a new teammate without a long onboarding doc.

  • Piyush G· Nov 27, 2024

    Useful defaults in pencil-design — fewer surprises than typical one-off scripts, and it plays nicely with `npx skills` flows.

showing 1-10 of 71

1 / 8