skill-name
Scannednpx machina-cli add skill ReScienceLab/opc-skills/template --openclawSkill Name
Brief description of the skill and its purpose.
Prerequisites
List any setup requirements:
- Environment variables needed
- API keys required
- Dependencies (already listed in frontmatter above)
Example setup:
export SKILL_API_KEY="your_api_key"
Quick Start
How to use the skill quickly:
cd <skill_directory>
python3 scripts/command.py --option value
Usage Examples
Example 1: Basic usage
python3 scripts/script.py "input"
Output:
Expected output here
Example 2: Advanced usage
python3 scripts/script.py "input" --flag --option value
Commands
All commands run from the skill directory.
Command 1
python3 scripts/script1.py --help
python3 scripts/script1.py "param1" --option value
Command 2
python3 scripts/script2.py "param1" "param2"
Scripts
script1.py- Description of what this script doesscript2.py- Description of what this script does
API Info
- Base URL: (if applicable)
- Rate Limits: (if applicable)
- Auth: (how authentication works)
- Docs: Link to official documentation
Troubleshooting
Issue 1
Symptom: Description of the problem
Solution:
- Step 1
- Step 2
Issue 2
Symptom: Description of the problem
Solution:
- Step 1
- Step 2
Examples
See examples/ directory for full workflow examples.
References
Notes
- Important note 1
- Important note 2
Frontmatter Guide
The YAML frontmatter at the top of this file is required:
| Field | Type | Required | Description |
|---|---|---|---|
name | string | ✓ | Unique identifier (kebab-case) |
description | string | ✓ | What the skill does and when to use it. Include trigger keywords and "Use when..." contexts inline. |
Creating Your Skill
- Copy this template to
skills/your-skill-name/ - Update the YAML frontmatter
- Write your SKILL.md documentation
- Add Python/shell scripts in
scripts/ - Add usage examples in
examples/ - Update
skills.jsonwith your skill entry - Test with your agent before submitting PR
Source
git clone https://github.com/ReScienceLab/opc-skills/blob/main/template/SKILL.mdView on GitHub Overview
skill-name provides a concise CLI framework with Python scripts to perform X, Y, or Z actions. It includes example usage, prerequisites, and commands to test behavior in a skill directory.
How This Skill Works
The skill is organized around Python scripts in a skill directory. Prerequisites define environment vars and API keys, and the Quick Start shows how to invoke scripts (e.g., python3 scripts/command.py --option value) to produce outputs. Commands like script1.py and script2.py are documented for various workflows.
When to Use It
- When you need to execute a quick CLI command with a single input.
- When you want to pass flags or options to customize behavior.
- When you are setting up or testing the skill locally in its directory.
- When you want to view available commands via --help and verify options.
- When you need to reference or apply usage examples to validate outputs.
Quick Start
- Step 1: cd <skill_directory>
- Step 2: python3 scripts/command.py --option value
- Step 3: python3 scripts/script.py "input" to see the output
Best Practices
- Store and reference environment variables securely (e.g., SKILL_API_KEY).
- Test in a virtual environment and keep dependencies explicit.
- Use --help to discover available commands before running scripts.
- Quote multi-word inputs to avoid shell parsing issues.
- Document edge cases and update examples accordingly.
Example Use Cases
- Run a basic script with a single input to verify expected output.
- Execute advanced usage with flags to see how options modify results.
- List commands and verify behavior with help text from --help.
- Switch between script1.py and script2.py in a workflow to compare results.
- Consult the Examples section to reproduce typical workflows.
