playbooks

home / skills / resciencelab / opc-skills / template

template skill

/template

This skill helps solopreneurs automate routine tasks by executing Python scripts and CLI commands to streamline operations and decision-making.

npx playbooks add skill resciencelab/opc-skills --skill template

Review the files below or copy the command above to add this skill to your agents.

Files (1)
SKILL.md
2.5 KB
---
name: skill-name
description: Clear description of what this skill does and when to use it. Include trigger keywords and contexts inline, e.g. "Use when user wants to X, Y, or Z."
---

# Skill 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:
```bash
export SKILL_API_KEY="your_api_key"
```

## Quick Start

How to use the skill quickly:

```bash
cd <skill_directory>
python3 scripts/command.py --option value
```

## Usage Examples

### Example 1: Basic usage

```bash
python3 scripts/script.py "input"
```

Output:
```
Expected output here
```

### Example 2: Advanced usage

```bash
python3 scripts/script.py "input" --flag --option value
```

## Commands

All commands run from the skill directory.

### Command 1
```bash
python3 scripts/script1.py --help
python3 scripts/script1.py "param1" --option value
```

### Command 2
```bash
python3 scripts/script2.py "param1" "param2"
```

## Scripts

- `script1.py` - Description of what this script does
- `script2.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**:
1. Step 1
2. Step 2

### Issue 2

**Symptom**: Description of the problem

**Solution**:
1. Step 1
2. Step 2

## Examples

See `examples/` directory for full workflow examples.

## References

- [Official Documentation](https://example.com)
- [API Reference](https://example.com/api)
- [Related Skill](https://github.com/ReScienceLab/opc-skills/tree/main/skills/related-skill)

## 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

1. Copy this template to `skills/your-skill-name/`
2. Update the YAML frontmatter
3. Write your SKILL.md documentation
4. Add Python/shell scripts in `scripts/`
5. Add usage examples in `examples/`
6. Update `skills.json` with your skill entry
7. Test with your agent before submitting PR

Overview

This skill provides a compact, command-driven toolkit for solopreneurs to run and integrate Python-based agent utilities. Use when you want quick CLI automation, local script orchestration, or to prototype API-backed agent behaviors using trigger keywords like "run", "deploy", "script", and "integrate." It bundles scripts, usage examples, and troubleshooting steps to speed setup and iteration.

How this skill works

The skill exposes small Python scripts in a scripts/ directory that you run from the skill folder to perform tasks or call APIs. It inspects environment variables and required API keys, reads command-line arguments, and prints structured output for easy piping into other tools. Built-in help flags and example commands make it simple to test basic and advanced flows locally before integrating into an agent.

When to use it

  • Use when you want to run a quick automation or prototype with Python CLI scripts (trigger: "run script", "execute").
  • Use when you need to wire an external API into an agent workflow and want a local script wrapper (trigger: "integrate API", "call endpoint").
  • Use when debugging environment or auth issues for a solo agent deployment (trigger: "troubleshoot", "auth error").
  • Use when preparing reproducible examples or command snippets for documentation or demos (trigger: "example", "demo").

Best practices

  • Set required environment variables (API keys, endpoints) before running scripts; follow the example export commands.
  • Start with provided quick-start commands to validate the environment and dependencies.
  • Use the built-in --help flags on each script to discover options and flags before running advanced flows.
  • Keep sensitive keys out of version control; use .env files or CI secrets where appropriate.
  • Run examples from the skill directory so relative paths and imports resolve cleanly.

Example use cases

  • Quickly call a third-party API via a local wrapper script to test rate limits and auth steps.
  • Run a demo workflow from examples/ to show an agent capability during a client presentation.
  • Wrap complex agent logic behind a simple CLI for repeatable testing and CI integration.
  • Troubleshoot auth or environment variable issues using guided troubleshooting steps.

FAQ

What setup is required?

Install Python dependencies, set required environment variables (API keys, endpoints), and run scripts from the skill directory.

How do I see available commands?

Run any script with --help to list options and usage examples.

Can I integrate these scripts into CI or an agent?

Yes. The scripts are designed to be called from CI pipelines or agent workflows; ensure secrets and environment variables are provided securely.