Skip to content

AGENTS.md

Latest commit

 

History

History
68 lines (49 loc) · 2.23 KB

AGENTS.md

File metadata and controls

68 lines (49 loc) · 2.23 KB

AGENTS.md

This file provides guidance to AI coding agents when working with code in this repository.

Repository Purpose

Centralized repo for shared AI agent configuration (skills, commands) used across WalletConnect projects. Files here mirror ~/.claude/ structure for syncing to local machines.

Commands

# Validate all files (frontmatter, structure)
./scripts/validate.sh

# Install to local ~/.claude/
./scripts/install.sh
./scripts/install.sh --force  # overwrite existing

# Sync between repo and local
./scripts/sync.sh             # interactive bi-directional
./scripts/sync.sh --pull      # repo → local
./scripts/sync.sh --push      # local → repo
./scripts/sync.sh --dry-run   # preview only

npm equivalents: npm run validate, npm run install-files, npm run sync

Architecture

.claude/
├── skills/           # Full skills with SKILL.md + optional references
│   └── <name>/
│       ├── SKILL.md           # Required: frontmatter + instructions
│       ├── REFERENCE.md       # Optional: API docs, schemas
│       ├── WORKFLOWS.md       # Optional: multi-step procedures
│       └── references/        # Optional: supporting files
└── commands/         # Simple prompt templates (flat .md files)

Skills vs Commands

  • Skills (skills/<name>/SKILL.md): Complex, multi-file capabilities with structured workflows. Require name and description frontmatter.
  • Commands (commands/<name>.md): Simple prompt templates. Frontmatter optional.

Frontmatter Requirements

Skills require YAML frontmatter:

---
name: lowercase-hyphen-only
description: What it does. When to use it.
---

Validation

The validate.sh script checks:

  • Frontmatter exists and is valid YAML
  • Required fields present (name, description)
  • model field valid if present (haiku/sonnet/opus)
  • Skill directory names match skill names

Always run ./scripts/validate.sh before committing changes to .claude/.

README Maintenance

When adding, removing, or meaningfully changing any skill, command, or script, you MUST update README.md to reflect the change. This includes updating the tables of available skills/commands and any relevant documentation sections.