Skip to content

CLAUDE.md

Latest commit

 

History

History
107 lines (77 loc) · 2.76 KB

CLAUDE.md

File metadata and controls

107 lines (77 loc) · 2.76 KB
Raw

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Repository Purpose

This repository contains Claude Code plugins - modular extensions that add specialized capabilities to Claude Code. See README.md for the list of available plugins and installation instructions.

Architecture

Plugin Structure

Plugins follow the Claude Code plugin convention:

<plugin-name>/
├── .claude-plugin/
│   └── plugin.json          # Plugin manifest (name, version, description)
└── skills/
    └── <skill-name>/
        ├── SKILL.md         # Skill instructions and triggers
        ├── scripts/         # Executable scripts
        └── references/      # Documentation loaded on-demand

Key Concepts

  • Skills are auto-triggered based on their description field in SKILL.md frontmatter
  • ${CLAUDE_PLUGIN_ROOT} must be used for all intra-plugin path references (ensures portability)
  • References are loaded into context only when needed (progressive disclosure)
  • Scripts can be executed directly without loading into context

Testing Plugins

Test the databricks-executor script:

python3 databricks-executor-plugin/skills/databricks-executor/scripts/databricks_exec.py --help

Plugin Installation

From marketplace (users):

/plugin marketplace add liam-machine/liam
/plugin install <plugin-name>@liam-machine/liam

Local development (contributors):

ln -s /path/to/liam/<plugin-name> ~/.claude/plugins/<plugin-name>

IMPORTANT: When Creating New Plugins

When creating a new plugin in this repository, you MUST update both files:

1. Update marketplace.json

Add a new entry to the plugins array:

{
  "name": "<plugin-name>",
  "source": "./<plugin-name>",
  "description": "<one-line description>",
  "version": "1.0.0",
  "author": {
    "name": "Liam Wynne"
  },
  "license": "MIT",
  "keywords": ["keyword1", "keyword2"],
  "category": "<category>"
}

2. Update README.md

Add the new plugin to the "Plugins" section using a collapsible <details> block:

<details>
<summary><strong><plugin-name></strong> - <short description></summary>

### <plugin-name>

<One-line description of what the plugin does>

| Feature | Description |
|---------|-------------|
| Key1 | Value1 |
| Key2 | Value2 |

**Quick Start:**
\`\`\`bash
# Setup (if needed)
export VAR="value"

# Example usage
python3 ${CLAUDE_PLUGIN_ROOT}/skills/<skill-name>/scripts/<script>.py -c "example"
\`\`\`

See [configuration guide](<plugin-name>/skills/<skill-name>/references/configuration.md) for detailed setup.

</details>

Keep descriptions concise - detailed documentation belongs in the plugin's references/ directory.