Appearance

  2. Tutorials
  3. Coding with Ogma and AI

Using Ogma API with AI ​

Ogma AI skill ​

The Ogma AI skill provides advanced capabilities for coding with Ogma. It follows the AgentSkills.io standard and works with Claude Code, GitHub Copilot, Cursor, Codex, VS Code, OpenCode and Gemini CLI.

Run this command in your terminal:

bash
curl -sL https://doc.linkurious.com/ogma/latest/install-ogma-skill.mjs | node

This installs the skill to ~/.agents/skills/, the shared location that Cursor, Codex, GitHub Copilot, VS Code, OpenCode and Gemini CLI all read, and to ~/.claude/skills/ when Claude Code is present, since Claude Code does not read .agents. It is already bundled within the npm create app project.

Useful flags:

bash
# see the targets and which ones were detected
curl -sL https://doc.linkurious.com/ogma/latest/install-ogma-skill.mjs | node - --list

# install into the current project rather than your home directory
curl -sL https://doc.linkurious.com/ogma/latest/install-ogma-skill.mjs | node - --project

# report what would happen without writing anything
curl -sL https://doc.linkurious.com/ogma/latest/install-ogma-skill.mjs | node - --dry-run

Alternatively, npx skills can install the archive directly, if you already use it to manage skills:

bash
npx skills add https://doc.linkurious.com/ogma/latest/ogma-skill.zip

Manual installation ​

  1. Download ogma-skill.zip
  2. Extract the ogma-skill folder to one of:
    • Any tool reading the shared path: ~/.agents/skills/ogma-skill/
    • Claude Code: ~/.claude/skills/ogma-skill/
    • GitHub Copilot CLI: ~/.copilot/skills/ogma-skill/
    • Cursor: ~/.cursor/skills/ogma-skill/
    • OpenCode: ~/.config/opencode/skills/ogma-skill/
    • Gemini CLI: ~/.gemini/skills/ogma-skill/

In GitHub Copilot CLI you can then run /skills to verify it is loaded, and invoke it explicitly with /skills ogma-skill.

To scope the skill to a single project instead, put it in .agents/skills/ogma-skill/ at the root of that project. Most coding agents pick it up from there, but check your agent's documentation. Take care not to commit it, since it is not source code.

Update the skill ​

To update to the latest version, simply run the install command again - it will replace the existing installation.

Using the skill ​

Once installed:

  • The skill auto-activates when you're working with Ogma code
  • You can explicitly invoke it with /ogma-skill or mention "use Ogma skill"
  • It provides API reference, code templates, and best practices

Cursor rule ​

Prefer a single always-resident file over an installed skill? ogma-rule.mdc is a lightweight, single-file Cursor rule generated from the skill's SKILL.md plus a short summary of each concept - covering the same ground at a glance, without the skill's progressive loading. Download it and save it as ogma-rule.mdc in .cursor/rules/ (or any tool that reads .mdc rule files) - it's served with a .txt extension so it downloads as plain text rather than as a page. For anything beyond the summary, it links back to the full skill and the API docs.

AI-compatible API documentation ​

Ogma's API documentation is available in .md format consumable by AI tools like GitHub Copilot or ChatGPT. You can use this context.md and point your AI coding agent at it. This allows you to use AI tools to write code that uses Ogma's API directly in your IDE.