Agent Skill — agentskills.io compatible

Teach your AI agent to deal cards.

ink-playing-cards ships with an Agent Skill — a structured knowledge file that gives coding agents deep understanding of the library's API, architecture, and patterns. One install and your agent writes correct ink-playing-cards code on the first try.

npx skills add gfargo/ink-playing-cards

What the agent learns.

One file gives your coding agent complete context on ink-playing-cards — no more hallucinated APIs or wrong import paths.

Full API Reference

Every component, hook, type, and utility documented with signatures and usage examples.

Architecture Context

DeckProvider, zone system, event/effect pipelines — the agent understands how pieces connect.

Gotchas & Patterns

Common pitfalls (async dispatch, type guards, ID requirements) called out explicitly so the agent avoids them.

Code Generation

Ask "build me a blackjack game" and get working ink-playing-cards code — not generic card logic.

Install the skill.

Multiple paths depending on your workflow. The skills CLI is the fastest.

skills CLI

recommended

The Vercel skills CLI auto-detects your agent and symlinks the skill into the right directory. One command, works everywhere.

npx skills add gfargo/ink-playing-cards

Supports Claude, Cursor, Kiro, Copilot, Codex, Amp, Goose, and more. Shows up on skills.sh automatically.

📦

Bundled with npm

automatic

The skill ships inside the npm package. If you use skills-npm, it auto-discovers and symlinks skills from your node_modules.

npm install ink-playing-cards
npx skills-npm          # discovers & symlinks bundled skills

Uses the "agents" field in package.json for discovery. Zero extra config.

🔗

Manual (any agent)

universal

Copy the SKILL.md directly into your agent's skills directory. Works with any tool that reads the open Agent Skills format.

# Clone and copy
git clone https://github.com/gfargo/ink-playing-cards
cp -r ink-playing-cards/skills/ink-playing-cards/ .claude/skills/
# Or for other agents:
# Kiro:   .kiro/skills/ink-playing-cards.md
# Cursor: .cursor/skills/ink-playing-cards/SKILL.md
# Copilot: .github/skills/ink-playing-cards/SKILL.md

The skill is a single markdown file — no dependencies, no build step.

Works everywhere.

The Agent Skills spec is open. One SKILL.md works across all major coding agents.

🟣

Claude Code

.claude/skills/

🐙

GitHub Copilot

.github/skills/

📐

Cursor

.cursor/skills/

🌀

Kiro

.kiro/skills/

📘

Codex

.codex/skills/

Amp

.agents/skills/

🪿

Goose

.goose/skills/

See it in action.

With the skill installed, your agent generates correct, idiomatic ink-playing-cards code from natural language prompts.

Prompt

“Build a simple war card game where two players flip cards and the higher value wins the round. Show scores and a play-again option.”

Agent output (with skill)

import { DeckProvider, useDeck, useHand, Card }
  from 'ink-playing-cards'
import { render, Box, Text, useInput } from 'ink'

// Agent uses correct hooks, dispatch patterns,
// type guards, and component props — no
// hallucinated APIs, no wrong imports.

How distribution works.

The skill is a markdown file in a folder — vendor-agnostic, no lock-in. It's distributed through multiple channels simultaneously.

🏪

skills.sh marketplace

No submission process. Once people install via npx skills add, the skill appears on the skills.sh leaderboard automatically via install telemetry.

📦

npm package

The skill is bundled in the published npm package under skills/. Tools like skills-npm and npm-agentskills auto-discover it from the "agents" field in package.json.

🐙

GitHub repo

The source of truth lives at skills/ink-playing-cards/SKILL.md in the repo. The skills CLI pulls directly from here — no registry needed.

ink-playing-cards/
├── skills/                    # Ships with npm + used by skills CLI
│   └── ink-playing-cards/
│       └── SKILL.md           # The skill (source of truth)
├── package.json               # "agents" field for npm discovery
└── dist/                      # Compiled library code