Ebean ORM Skills for AI Coding Agents

Structured knowledge packages that AI coding agents load on-demand when working with Ebean ORM.

These skills follow the Agent Skills standard and work with any compatible harness, including pi and Claude Code.

Available Skills

Skill	Description
ebean-orm	Entity modeling, querying, persistence, testing, project setup, and migrations

Installation

Option A — Clone and symlink (recommended)

git clone git@github.com:ebean-orm/skills.git ~/.agents/ebean-skills
mkdir -p ~/.agents/skills
ln -sf ~/.agents/ebean-skills/ebean-orm ~/.agents/skills/ebean-orm

To update:

cd ~/.agents/ebean-skills && git pull

Option B — Clone directly into skills directory

git clone git@github.com:ebean-orm/skills.git /tmp/ebean-skills
cp -r /tmp/ebean-skills/ebean-orm ~/.agents/skills/ebean-orm
rm -rf /tmp/ebean-skills

Option C — Project-level installation

Make the skill available to all contributors on a specific project:

# From your project root
git clone git@github.com:ebean-orm/skills.git /tmp/ebean-skills
cp -r /tmp/ebean-skills/ebean-orm .agents/skills/ebean-orm
rm -rf /tmp/ebean-skills
git add .agents/skills/ebean-orm

Verification

After installation, verify the skill is loaded by your agent. In pi:

/skills

You should see ebean-orm listed.

How It Works

The skill uses progressive disclosure:

1. The agent sees only the skill name and description at startup
2. When a task matches (e.g., "add Ebean to this project"), the agent loads SKILL.md
3. SKILL.md provides a Quick Reference and links to detailed reference guides
4. The agent loads only the specific reference it needs for the task

Structure

ebean-orm/
├── SKILL.md                    # Entry point — key principles, quick reference
└── references/                 # Detailed guides (loaded on demand)
    ├── setup.md                # POM setup, test container, database config
    ├── modeling.md             # Entity creation, Lombok
    ├── querying.md             # Query beans, fetch tuning, DTOs
    ├── write-transactions.md   # Persist, transactions, batching
    ├── testing.md              # TestEntityBuilder
    └── db-migrations.md        # Migration generation

Regenerating References

The reference files are generated by concatenating source guides from the ebean repo (docs/guides/).

# Expects the ebean repo at ../ebean (sibling directory)
./generate-references.sh

# Or specify the location
EBEAN_REPO=/path/to/ebean ./generate-references.sh

License

Apache 2.0 — see LICENSE.