Search the Qalma docs

Type at least two characters to get started.

Docs

Agent Skills

Qalma ships an optional agent skill pack for coding agents that understand SKILL.md folders. The skill teaches an agent how to integrate @qalma/editor, compose Angular-owned editor UI, choose first-party plugins, author custom Qalma plugins, and debug common editor behavior.

The npm package is @qalma/skills. The main install command is:

npx @qalma/skills add

That command installs the Qalma skill into:

./.agents/skills/qalma

Use it when you want an AI coding agent to have Qalma-specific project guidance inside your Angular repository.

Requirements

You need Node.js and a package runner such as npx. The skill pack is separate from the editor runtime: installing it does not add @qalma/editor to your app and does not change your Angular code.

Install the editor itself with:

npm install @qalma/editor

Install the agent guidance with:

npx @qalma/skills add

Install For Your Agent

The default target is tool-agnostic and works for agents that read ./.agents/skills:

npx @qalma/skills add

For Claude Code, install to ./.claude/skills/qalma:

npx @qalma/skills add --target claude

For Codex, install to ./.agents/skills/qalma, the project-local skills directory Codex scans by default:

npx @qalma/skills add --target codex

For a custom location, pass --dir:

npx @qalma/skills add --dir ./tools/agent-skills/qalma

Options

Option Description
--target agents Install to ./.agents/skills/qalma. This is the default.
--target claude Install to ./.claude/skills/qalma.
--target codex Install to ./.agents/skills/qalma, the same location as agents.
--dir <path> Install to an explicit folder instead of a known target.
--cwd <path> Resolve the target directory from another working directory.
--force Replace an existing Qalma skill folder.

The installer refuses to overwrite an existing folder unless --force is passed. This protects local edits to the installed skill.

Update The Skill

Run the same command with --force to refresh an existing install:

npx @qalma/skills add --force

Use the same target you originally installed with:

npx @qalma/skills add --target claude --force

What Gets Installed

The installed folder is named qalma and contains:

  • SKILL.md — the entry point your agent reads.
  • references/ — focused guidance for editor integration, plugin authoring, troubleshooting, and contributing to Qalma.
  • agents/openai.yaml — metadata for agents that read OpenAI-style skill UI hints.

The skill is documentation and workflow guidance for agents. It does not run in your application bundle.

Next Steps