> For the complete documentation index, see [llms.txt](https://docs-lunar.earthly.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs-lunar.earthly.dev/install/skills.md).

# AI Skills

The [earthly/skills](https://github.com/earthly/skills) repository provides AI agent skills for working with Lunar. These skills enable AI assistants to help you build custom plugins, edit your `lunar-config.yml`, and query Lunar's data model.

## Available Skills

| Skill                                                                                 | Description                                                                                                         |
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
| [lunar-collector](https://github.com/earthly/skills/tree/main/skills/lunar-collector) | Create Lunar collector plugins (Bash scripts) that gather SDLC metadata                                             |
| [lunar-cataloger](https://github.com/earthly/skills/tree/main/skills/lunar-cataloger) | Create Lunar cataloger plugins (Bash scripts) that build the software catalog from external systems or repo signals |
| [lunar-policy](https://github.com/earthly/skills/tree/main/skills/lunar-policy)       | Create Lunar policy plugins (Python scripts) that enforce engineering standards                                     |
| [lunar-config](https://github.com/earthly/skills/tree/main/skills/lunar-config)       | Edit `lunar-config.yml` — wire together components, domains, collectors, policies, catalogers, and initiatives      |
| [lunar-sql](https://github.com/earthly/skills/tree/main/skills/lunar-sql)             | Craft SQL queries against Lunar's data model (components, checks, policies, domains, PRs)                           |

## Installation

Install with the [`skills`](https://github.com/vercel-labs/skills) CLI:

```bash
# Install all Lunar skills globally
npx skills add earthly/skills -g

# Or install a specific skill globally
npx skills add earthly/skills -g --skill lunar-policy
```

The CLI auto-detects which coding agents you have installed (Claude Code, Codex, Cursor, and 50+ more) and copies the skills to the right location. See the [`skills` CLI docs](https://github.com/vercel-labs/skills) for more commands like `list`, `update`, and `remove`.

Drop `-g` to install into the current project's `.claude/skills/` (or equivalent) instead — useful if you want to commit the skills into a shared team repo.

## Usage

These skills are designed to be used with AI agents that support the Claude/Codex skill format. Each skill contains:

* `SKILL.md` - Main instructions and quick-start guide
* `references/` - Curated documentation for the AI to consult as needed

Once installed, your AI assistant will automatically detect and use these skills when you ask it to build a Lunar plugin, edit your config, or query the SQL API.

## Related Resources

* [Bash SDK](/plugin-sdks/bash-sdk.md) - Manual reference for building collectors and catalogers
* [Python SDK](/plugin-sdks/python-sdk.md) - Manual reference for building policies
* [lunar-config.yml](/configuration/lunar-config.md) - Manual reference for the configuration file
* [SQL API](/sql-api/sql-api.md) - Manual reference for querying Lunar data
* [lunar-lib Repository](https://github.com/earthly/lunar-lib) - Reference collectors, catalogers, and policies


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs-lunar.earthly.dev/install/skills.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.