1.4 KiB
1.4 KiB
Local Development Setup
This runbook covers setting up a local development environment for
molecule-dev.
Prerequisites
- Python 3.11+
ghCLI authenticated- Write access to
Molecule-AI/molecule-ai-plugin-molecule-dev
Clone & Bootstrap
git clone https://git.moleculesai.app/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
- Create
rules/<rule-name>/RULES.mdorskills/<skill-name>/SKILL.md - Follow the format of existing rules/skills in the repo
- Validate the plugin structure (above)
- Add tests in
tests/if applicable
Troubleshooting
"No module named yaml"
Install PyYAML:
pip install pyyaml
Plugin validation fails
- Ensure
plugin.yamlhas 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'))"
Related
skills/molecule-dev/SKILL.md— dev tooling documentationrules/— existing rules