Appearance

  2. Tutorials
  3. Coding with Ogma and AI

Using Ogma API with AI ​

WARNING

This tutorial is a work in progress. It will be updated with more examples and details soon.

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, Cursor, Codex, and OpenCode.

Run this command in your terminal:

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

This auto-detects your installed AI tools and installs the skill to the correct location.

Installing in GitHub Copilot CLI ​

If you're using GitHub Copilot CLI, you can install the skill manually and then manage it with the /skills command:

  1. Download ogma-skill.zip
  2. Extract the ogma-skill folder to ~/.copilot/skills/ogma-skill/
  3. Launch copilot and run /skills to verify it is loaded

Once installed, the skill auto-activates when you're working with Ogma code, or you can invoke it explicitly with:

/skills ogma-skill

Manual installation ​

If you prefer manual installation for other tools:

  1. Download ogma-skill.zip
  2. Extract the ogma-skill folder to:
    • Claude Code: ~/.claude/skills/ogma-skill/
    • GitHub Copilot CLI: ~/.copilot/skills/ogma-skill/
    • Cursor: ~/.cursor/skills/ogma-skill/
    • Codex: ~/.codex/skills/ogma-skill/
    • OpenCode: ~/.config/opencode/skill/ogma-skill/

Alternatively, you can keep ogma-skill locally in the project where it's used, by checking it into the ./agents/skills/ogma-skill. Most of the coding agents will pick it up from there, but check your agent's documentation for details. But you should be careful not to commit it to your repository, 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

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.

You can also use our draft for Cursor.AI rule, we will soon update it with more examples and details.