molecule-ai-plugin-molecule.../runbooks/local-dev-setup.md
Hongming Wang af4e0faeef
Some checks failed
CI / validate (push) Failing after 0s
import from local vendored copy (2026-05-06)
2026-05-06 13:53:26 -07:00

1.4 KiB

Local Development Setup

This runbook covers setting up a local development environment for molecule-dev.


Prerequisites

  • Python 3.11+
  • gh CLI authenticated
  • Write access to Molecule-AI/molecule-ai-plugin-molecule-dev

Clone & Bootstrap

git clone https://github.com/Molecule-AI/molecule-ai-plugin-molecule-dev.git
cd molecule-ai-plugin-molecule-dev

Validating Plugin Structure

python3 -c "import yaml; yaml.safe_load(open('plugin.yaml'))"
echo "plugin.yaml OK"

Testing the Dev Tools

Run the test suite to verify all dev tooling is functional:

python3 -m pytest tests/ -v

Writing New Rules or Skills

  1. Create rules/<rule-name>/RULES.md or skills/<skill-name>/SKILL.md
  2. Follow the format of existing rules/skills in the repo
  3. Validate the plugin structure (above)
  4. Add tests in tests/ if applicable

Troubleshooting

"No module named yaml"

Install PyYAML:

pip install pyyaml

Plugin validation fails

  • Ensure plugin.yaml has all required fields: name, version, description
  • Ensure at least one of: SKILL.md, hooks/, skills/, rules/
  • Check the schema with: python3 -c "import yaml; yaml.safe_load(open('plugin.yaml'))"

  • skills/molecule-dev/SKILL.md — dev tooling documentation
  • rules/ — existing rules