106 lines
2.5 KiB
Markdown
106 lines
2.5 KiB
Markdown
# OpenCode Skills
|
|
|
|
Personal collection of OpenCode skills for AI-powered terminal coding assistant.
|
|
|
|
## Skills
|
|
|
|
### skill-creator
|
|
Create new OpenCode skills with proper structure and templates.
|
|
|
|
**Usage:**
|
|
```bash
|
|
python3 scripts/create_skill.py <skill-name> "<description>"
|
|
```
|
|
|
|
**Features:**
|
|
- Auto-generates SKILL.md with proper frontmatter
|
|
- Creates script template with env loading
|
|
- Validates skill naming conventions
|
|
- Sets up .env.example and requirements.txt
|
|
|
|
## Quick Install (Recommended)
|
|
|
|
Use the automated installer - it will:
|
|
- Detect all skills in the repo
|
|
- Prompt for required environment variables
|
|
- Create `.env` files with your credentials
|
|
- Install skills to OpenCode (global or per-project)
|
|
- Install Python dependencies
|
|
|
|
```bash
|
|
./scripts/install-skills.sh
|
|
```
|
|
|
|
## Manual Setup
|
|
|
|
If you prefer manual setup:
|
|
|
|
1. Install dependencies:
|
|
```bash
|
|
# Dependencies are installed automatically by install-skills.sh
|
|
```
|
|
|
|
2. Configure API tokens in `.env`:
|
|
```bash
|
|
# Copy .env.example to .env and add your credentials
|
|
```
|
|
|
|
3. Install skills to OpenCode:
|
|
```bash
|
|
# Global install (available for all projects)
|
|
mkdir -p ~/.config/opencode/skills
|
|
cp -r skills/* ~/.config/opencode/skills/
|
|
|
|
# Or project-specific install
|
|
mkdir -p .opencode/skills
|
|
cp -r skills/* .opencode/skills/
|
|
```
|
|
|
|
## OpenClaw Installation
|
|
|
|
For OpenClaw, you need to install both skills AND credentials:
|
|
|
|
```bash
|
|
# Option 1: Local OpenClaw folder
|
|
mkdir -p ~/.openclaw/skills
|
|
cp -r skills/* ~/.openclaw/skills/
|
|
cp .env ~/.openclaw/.env
|
|
|
|
# Option 2: Remote server SSH mount (e.g. ~/openclaw-vps/)
|
|
mkdir -p ~/openclaw-vps/.openclaw/skills
|
|
cp -r skills/* ~/openclaw-vps/.openclaw/skills/
|
|
cp .env ~/openclaw-vps/.openclaw/.env
|
|
|
|
# Option 3: rsync for faster sync over SSH
|
|
rsync -av skills/ user@remote-server:.openclaw/skills/
|
|
rsync -av .env user@remote-server:.openclaw/.env
|
|
```
|
|
|
|
**What to copy:**
|
|
- `skills/` - All skill folders
|
|
- `.env` - Credentials (API keys, tokens)
|
|
|
|
**Note:** OpenClaw searches for skills in `~/.openclaw/skills` or any `*/.openclaw/skills` folder.
|
|
|
|
## Creating New Skills
|
|
|
|
Use the skill-creator to scaffold new skills:
|
|
|
|
```bash
|
|
python3 skills/skill-creator/scripts/create_skill.py my-new-skill "Description of what it does"
|
|
```
|
|
|
|
Then edit the generated files:
|
|
1. `SKILL.md` - Define commands and options
|
|
2. `scripts/my_new_skill.py` - Implement the functionality
|
|
3. `scripts/.env.example` - Add required environment variables
|
|
|
|
## Security
|
|
|
|
- `.env` files are gitignored (never commit actual credentials)
|
|
- Use `.env.example` as template only
|
|
|
|
## License
|
|
|
|
MIT
|