arkyn
ChangelogGuides
docs / cli / introduction

Introduction to @arkyn/cli

@arkyn/cli is a command-line tool for the Arkyn ecosystem. It closes a gap that shows up whenever an AI coding assistant (Claude Code, Cursor, Copilot, etc.) works inside a project that consumes @arkyn/* packages: the assistant has no built-in knowledge of which components, hooks, or utilities are available, or how to use them correctly.
Starting with Arkyn v3.0.8, every published package (@arkyn/components, @arkyn/server, @arkyn/shared, @arkyn/templates) ships its own AGENTS.md file inside the package itself, a reference written specifically for AI assistants, documenting every export's exact signature, props, and import path. @arkyn/cli is the tool that connects those files to your project: it inspects your package.json, finds which @arkyn/* packages you have installed, and links their AGENTS.md docs into your own project's AGENTS.md, so your assistant picks them up automatically.

Why @arkyn/cli?

  • Zero install: designed to be run with npx/bunx, nothing is left installed in your project afterward unless you choose to add it as a devDependency.
  • Automatic discovery: detects every installed @arkyn/* package for you, no manual list to maintain.
  • Idempotent and non-destructive: safe to rerun as often as you like; it only ever touches its own marked block in AGENTS.md, everything else you've written stays untouched.
  • No new authoring work: the AGENTS.md content already ships inside each @arkyn/* package, @arkyn/cli just links it into your project.

Installation

No installation is required. Run it directly with npx or bunx:

bash

npx @arkyn/cli init --agents
# or
bunx @arkyn/cli init --agents
If you'd rather keep it around and run it via a project script, install it as a devDependency instead:

bash

npm install --save-dev @arkyn/cli

Quick start

bash

cd my-app
npx @arkyn/cli init --agents
Updated AGENTS.md with docs for: @arkyn/components, @arkyn/server
Run the command again any time you install or remove an @arkyn/* package, so the list in your AGENTS.md stays in sync.

Requirements

  • Node.js >= 18.0.0
  • Bun >= 1.0.0

Commands

  • init --agents, creates or updates AGENTS.md in the current project with links to the AGENTS.md docs shipped by your installed @arkyn/* packages.
  • --help, prints usage information.

Next steps

Install the @arkyn/* packages you need, run npx @arkyn/cli init --agents in your project root, and your AI assistant will start reading the linked AGENTS.md docs the next time you ask it to use Arkyn. See init --agents for the full behavior and output format.
On this page
    arkyn