Skip to content

README.md

Latest commit

 

History

History
53 lines (38 loc) · 1.32 KB

README.md

File metadata and controls

53 lines (38 loc) · 1.32 KB

KOReader Dev Plugin

A Claude Code plugin to help with KOReader plugin development.

Features

  • Skill: KOReader plugin development knowledge (APIs, widgets, patterns)
  • Hooks: Automatic Lua linting on file save, task completion notifications
  • Commands: Scaffold new plugins, run linting manually

Prerequisites

  • luacheck - Lua linter 
    # macOS
brew install luacheck

# or via luarocks
luarocks install luacheck

Installation

# Test locally
claude --plugin-dir "/Users/uttamkumar/Desktop/Code Projects/koreader-dev"

# Or copy to project
cp -r koreader-dev /path/to/your/project/.claude-plugin/

Usage

Skill (Auto-activates)

The KOReader development skill activates when you ask about:

  • KOReader plugin structure
  • Lua widgets and UI components
  • Settings persistence
  • Menu integration

Commands

  • /koreader-dev:scaffold - Create new KOReader plugin boilerplate
  • /koreader-dev:lint - Run luacheck on Lua files

Hooks (Automatic)

  • PostToolUse: Runs luacheck after editing .lua files
  • Stop: macOS notification when tasks complete

KOReader Resources