Skip to main content
Inkly ships an agent skill for the CLI. Install it once so local coding agents can discover how to scaffold hubs, capture demos, preview locally, validate files, sync assets, and publish snapshots. The installed skill is an index. It gives agents the command map and points them to focused task skills when they need deeper instructions.

​
Install the Inkly CLI skill

Install the CLI first: 
npm install -g @inkly-org/cli
inkly version
Then install or refresh the bundled skill: 
inkly skills install
This command installs the Inkly CLI skill into every supported AI coding agent detected on your machine. Re-run it after upgrading the CLI.
inkly skills install uses npx under the hood. If it fails because npx is missing, install Node.js 20 or later and run the command again.

​
Install by agent provider

Use the same install command for each supported agent provider. The installer detects local agent directories and installs the Inkly skill where each provider expects local skills.
Agent providerHow to installHow to use it
Claude CodeRun npm install -g @inkly-org/cli, then inkly skills install. Restart Claude Code if it was already open.Ask Claude Code to use the Inkly skill when it captures, previews, validates, or polishes demos.
CursorRun npm install -g @inkly-org/cli, then inkly skills install from a terminal. Restart Cursor so the agent can pick up the new skill.Ask Cursor Agent to use the Inkly skill in the workspace that contains your hub or product.
CodexRun npm install -g @inkly-org/cli, then inkly skills install. Start a new Codex session after installation.Ask Codex to use the Inkly skill before it runs capture, polish, or publishing commands.
Other local agentsRun inkly skills install. If the provider supports the open skills layout, the installer can add Inkly automatically.If the provider is not detected, paste the relevant task skill URL into the agent prompt.
After installation, ask your agent to use the Inkly skill when it works on demos. For example: 
Use the Inkly CLI skill to capture and polish a demo of this product flow.

​
Task skills

For specific jobs, the Inkly CLI skill tells agents to load one of these focused playbooks.
SkillUse it whenURL
agent-captureYou want an image/video demo of a product URL.Open skill
agent-html-captureYou want an HTML demo with self-contained page snapshots.Open skill
agent-demo-polishYou want to polish a raw capture or assemble a demo from existing screenshots, videos, or materials.Open skill
inkly-cli-referenceYou need precise inkly.json, demo.config.json, or CLI/schema details.Open skill

​
If skills are not installed

You can still use Inkly with any agent that can read a URL and run commands. Paste the relevant task skill URL into the agent prompt. 
Read this Inkly skill and follow it exactly:
https://www.app.inklyai.dev/__inkly/skills/agent-capture.md

Capture an interactive demo of:
https://app.example.com
This fallback works well when you are using a hosted agent, a locked-down workstation, or an agent that does not yet support installed skills.

​
When to use each skill

  • Use agent-capture by default. It creates screenshot/video demos and supports motion.
  • Use agent-html-capture when you need crisp text, editable captured content, or HTML snapshots.
  • Use agent-demo-polish after capture, when the demo needs clearer labels, stronger copy, better annotations, chapters, covers, or cleanup.
  • Use inkly-cli-reference when the agent needs exact file shapes or schema details.
For the capture command surface, see Agentic capture. For the full command list, see CLI commands.