46 lines
1.8 KiB
Markdown
46 lines
1.8 KiB
Markdown
# .ai Directory Overview
|
|
|
|
## Purpose
|
|
The `.ai` directory contains all the modular skills and configurations that govern the AI's behavior, decision-making, and workflows. It is the central repository for AI instructions.
|
|
|
|
## Root-Skill: The Master Configuration
|
|
The `root-skill` is the **master configuration** and **state machine** for the AI. It must be read first to understand how the AI operates and interacts with other skills.
|
|
|
|
- **File Location:** `.ai/skills/root-skill/SKILL.md`
|
|
- **Key Rules:**
|
|
- Always start by reading `root-skill`.
|
|
- Follow the state machine rules defined in `root-skill`.
|
|
|
|
## Skills: Modular Instructions
|
|
Each skill is a modular instruction set designed for specific tasks. Skills are located in `.ai/skills/` and follow a consistent structure:
|
|
- **File Name:** `SKILL.md`
|
|
- **Metadata:** Each skill includes `name`, `description`, and `category`.
|
|
|
|
### Example Skills:
|
|
- **Core Principles:** Foundational behavior and decision-making rules.
|
|
- **Git:** Rules for Git operations and workflows.
|
|
- **IaC:** Infrastructure as Code principles.
|
|
|
|
## Local Usage (VS Code UI)
|
|
To list all skills and their descriptions, use the provided Bash script:
|
|
|
|
```bash
|
|
bash .ai/list-skills.sh
|
|
```
|
|
|
|
## Browser-Based AI Usage
|
|
|
|
For browser-based AI systems loads skills from file: '.ai/skill-list.txt'.
|
|
|
|
When using this project in a browser-based AI, ensure the AI reads `root-skill` first. To avoid scanning the entire directory:
|
|
1. Use the `list-skills.sh` script to locate relevant skills.
|
|
2. Focus on the `name` and `description` metadata in each skill.
|
|
|
|
## Bash Script: List Skills
|
|
A Bash script is provided to list all skills and their descriptions. See `.ai/list-skills.sh` for details.
|
|
|
|
## Further read
|
|
|
|
- https://github.com/mattpocock/skills/tree/main
|
|
- https://github.com/anthropics/skills/tree/main
|
|
|