Aerospike agent skills
This repository holds Aerospike-related Agent Skills under skills/. Each skill is a self-contained folder you can copy into Cursor, add to GitHub Copilot context via repo instructions, or use with Claude and other assistants. Skills focus on the core Aerospike Database (not Aerospike Graph).
Plain-language topics: real-time / low-latency key-value storage, Redis or Memcached–style patterns with persistence, feature stores, user profiles, client-side modeling and policies.
The canonical list of skills (and what to copy) is skills/README.md. More Aerospike skills may appear there over time.
Layout note: If you previously used aerospike-getting-started/ at the repository root, it now lives at skills/aerospike-getting-started/. That folder is for contributors who edit the skill sources; users install the compiled skill from compiled-skills/.
Skills in this repository
| Skill folder | Purpose | Entry |
|---|---|---|
aerospike-getting-started | Local Docker, namespaces/ports/TTL, first put/get, official client snippets, Community vs Enterprise, troubleshooting for new users | skills/aerospike-getting-started/SKILL.md |
aerospike-development | Application development: CDTs, expressions, indexes, batch/scan, policies, modeling against an existing schema, modular rules under references/ | skills/aerospike-development/SKILL.md |
aerospike-data-modeling | Design-time data modeling: deriving a schema from requirements when none exists yet, or redesigning one | skills/aerospike-data-modeling/SKILL.md |
Choosing a skill: Use getting-started when you need a dev instance, correct defaults, or a first verified read/write. Use development when you are writing or reviewing client code against a model that already exists. Use data-modeling when the schema itself is the deliverable. You can install all; they complement each other.
Out of scope for these skills: production cluster topology, full operations runbooks, Kubernetes/Helm, or cloud-specific deployment—for that, use Aerospike documentation (links also appear in the getting-started skill).
Who this is for
- Developers who want a working local instance and first client I/O (getting-started).
- Developers building or reviewing Aerospike client applications (development skill).
- Teams that want consistent AI-assisted answers when working with Aerospike.
What’s in the repo
| Path | Purpose |
|---|---|
| skills/README.md | Index of skills in this repository (update this when adding a skill) |
| skills/aerospike-getting-started/SKILL.md | Getting started: critical rules, anti-hallucination checklist, Docker steps, documentation links (YAML frontmatter for Cursor) |
| skills/aerospike-getting-started/examples.md | Per-language put/get examples and Node.js batching notes |
| skills/aerospike-getting-started/reference.md | Custom config, Docker Compose, Community vs Enterprise, troubleshooting |
| skills/aerospike-development/SKILL.md | Development skill: role, scope, mental model, pointers into references |
| skills/aerospike-development/references/README.md | TOC of modular rules and thin ex-* example tables |
| skills/aerospike-development/reference.md | Doc map and deeper pointers for client work |
| skills/aerospike-development/examples.md | Additional examples for the development skill |
| skills/aerospike-data-modeling/SKILL.md | Data modeling skill: design-time workflow, mental model, pointers into references |
| AGENTS.md | Short read order and routing for any AI assistant |
| compiled-skills/aerospike/ | Published agent skill: SKILL.md routes, references/ carries the rules it names |
| .github/copilot-instructions.md | GitHub Copilot repository instructions |
Skill packaging evaluation (structure A/B tests, coverage gates) runs in a separate harness repository and is not part of this repository's checks.
The canonical aerospike.conf and commands for local setup live in skills/aerospike-getting-started/SKILL.md (not duplicated here).
Using with AI assistants
We publish one skill: compiled-skills/aerospike/SKILL.md, compiled from the three authoring folders under skills/. Registries list that artifact only. The folders under skills/ are maintained for editing and compilation, not as separate install targets.
The skill and its rule files ship together — install the directory, not the single file, or the rules SKILL.md names will be missing. It is semantically versioned: each release is tagged vX.Y.Z, and an installed copy states its own version in metadata.version so you can tell what you have without checking back here.
| Tool | What to do |
|---|---|
| Any agent (recommended) | Add compiled-skills/aerospike/SKILL.md to always-on context. Install guide. Raw URL: https://raw.githubusercontent.com/aerospike/agent-skills/main/compiled-skills/aerospike/SKILL.md |
skills CLI (any supported agent) | npx skills add https://github.com/aerospike/agent-skills/tree/main/compiled-skills/aerospike installs the published skill. Do not use the repository root URL — the CLI discovers skills/ first and would install the uncompiled authoring folders. |
| Gemini CLI | npx skills add https://github.com/aerospike/agent-skills/tree/main/compiled-skills/aerospike -a gemini-cli installs to .agents/skills/aerospike/ (globally ~/.gemini/skills/). |
| GitHub Copilot | Uses .github/copilot-instructions.md in supported clients; see also AGENTS.md. |
| Claude Code / similar | Open CLAUDE.md and AGENTS.md; add compiled-skills/aerospike/SKILL.md to project instructions or skills. |
| Other chats (Claude, ChatGPT, etc.) | Upload or link compiled-skills/aerospike/SKILL.md. |
Use without AI tools (any editor)
Path A: First local instance and first put/get
- Read Critical rules and Hallucination blacklist in
skills/aerospike-getting-started/SKILL.md. - Run Autonomous first-run steps in the same file (Docker + config + verify logs).
- Pick your language in
examples.mdand run a write/read test. - For Compose, Enterprise evaluation, or troubleshooting, see
reference.md.
Path B: Application development (modeling, CDTs, policies)
- Read
skills/aerospike-development/SKILL.mdfor scope and mental model. - Use
skills/aerospike-development/references/README.mdfor the rules and example TOC;reference.mdandexamples.mdas needed.
First-hour checklist (getting-started skill)
Use this when your goal is a running local database and a verified first client write/read.
- Docker is installed and
docker --versionworks. - Aerospike container is running per
skills/aerospike-getting-started/SKILL.md(ports3000–3002mapped; add3003if you need admin access on Database 8.1.0+—see that file). - Logs show the ready line described in
SKILL.md(successful startup). - Client SDK installed for your language; write/read example prints success.
- (Optional) Skim Documentation links in the same
SKILL.mdfor next steps.
Maintenance and distribution
metadata.last_verified: Each skill’sSKILL.mdmay carrylast_verifiedundermetadata. When you change Docker images, client commands, or major facts for that skill, re-check the documented flow and update the date.- Linting skills: Run
./scripts/validate-skill.sh(see CONTRIBUTING.md); CI runs the same check via.github/workflows/skill-validator.yml. - Spec conformance: Run
./scripts/validate-spec.shto checkSKILL.mdfrontmatter against the Agent Skills specification; CI runs it via.github/workflows/spec-conformance.yml. - Publishing: Registry submission is automated on release—see
docs/PUBLISHING.md. - Compiled skill:
compiled-skills/is generated fromskills/. After editing any skill, runpython3 scripts/compile-agents.py --write; CI fails the PR if the compiled output is stale. Frontmatter for the published skill lives inscripts/skills_compile/published_skill.yaml. - Contributing: See CONTRIBUTING.md for how to add or edit skills and keep root docs in sync.
- Redistribution: This repository is licensed under the Apache License 2.0, matching aerospike/data-modeling-guide.
Official documentation
Links to Aerospike docs (quick start, configuration, clients, Docker) are collected in the Documentation links section at the bottom of skills/aerospike-getting-started/SKILL.md. The development skill’s reference.md points to additional client and operations documentation where relevant.