cokit-cli 1.0.9 → 1.2.2

package/templates/repo/.github/skills/INSTALLATION.md

@@ -0,0 +1,311 @@
+# Skills Installation Guide
+
+This guide explains how to install dependencies for skills.
+
+## Overview
+
+Skills are organized into groups with Python utility scripts. Each skill's scripts directory contains a `requirements.txt` file listing dependencies.
+
+## Automated Installation (Recommended)
+
+Use the provided installation scripts for automated setup:
+
+### Linux/macOS
+
+```bash
+cd $HOME/.copilot/skills
+chmod +x install.sh
+./install.sh
+```
+
+The script will:
+- Detect your OS (Linux or macOS)
+- Install package managers (Homebrew for macOS, apt-get for Linux)
+- Install system dependencies (FFmpeg, ImageMagick)
+- Install Node.js and global packages (rmbg-cli, pnpm, wrangler, repomix)
+- Create Python virtual environment
+- Install Python packages for all skills
+- Install test dependencies
+- Verify all installations
+
+### Windows (PowerShell)
+
+Run as Administrator:
+
+```powershell
+cd .copilot\skills
+Set-ExecutionPolicy Bypass -Scope Process -Force
+.\install.ps1
+```
+
+Options:
+```powershell
+# Skip Chocolatey installation if already installed
+.\install.ps1 -SkipChocolatey
+
+# Show help
+.\install.ps1 -Help
+```
+
+The script will:
+- Install Chocolatey package manager (if needed)
+- Install system dependencies (FFmpeg, ImageMagick)
+- Install Node.js and global packages
+- Create Python virtual environment
+- Install Python packages
+- Verify all installations
+
+### What Gets Installed
+
+**System Tools:**
+- FFmpeg (video/audio processing)
+- ImageMagick (image processing)
+
+**Node.js Packages (global):**
+- rmbg-cli (AI background removal)
+- pnpm (package manager)
+- wrangler (Cloudflare CLI)
+- repomix (repository packaging)
+
+**Python Packages:**
+- google-genai (Gemini API)
+- pypdf, python-docx (document processing)
+- Pillow (image processing)
+- pytest, pytest-cov (testing)
+
+## Manual Installation
+
+If you prefer manual installation or the automated script fails:
+
+## Quick Start
+
+### Option 1: Install All Dependencies (Recommended)
+
+```bash
+# Create virtual environment
+python3 -m venv .venv
+source .venv/bin/activate  # On Windows: .venv\Scripts\activate
+
+# Install test dependencies for development
+pip install pytest pytest-cov pytest-mock
+```
+
+## Skills Dependencies
+
+### Python Package Dependencies
+
+Most skills use only Python standard library and require no external packages.
+
+### System Tool Dependencies
+
+Several skills require external CLI tools:
+
+#### Media Processing CLI Tools
+- **FFmpeg**: Video/audio processing
+  - Ubuntu/Debian: `sudo apt-get install ffmpeg`
+  - macOS: `brew install ffmpeg`
+  - Windows: `choco install ffmpeg`
+- **ImageMagick**: Image processing
+  - Ubuntu/Debian: `sudo apt-get install imagemagick`
+  - macOS: `brew install imagemagick`
+  - Windows: `choco install imagemagick`
+- **RMBG CLI**: AI background removal
+  - All platforms: `npm install -g rmbg-cli`
+
+#### devops
+- **Cloudflare Wrangler**: `npm install -g wrangler`
+- **Docker**: https://docs.docker.com/get-docker/
+- **Google Cloud CLI**: https://cloud.google.com/sdk/docs/install
+
+#### repomix
+- **Node.js 18+**: https://nodejs.org/
+- **Repomix**: `npm install -g repomix`
+
+#### databases
+- **PostgreSQL client**: `sudo apt-get install postgresql-client` (Linux)
+- **MongoDB Shell**: https://www.mongodb.com/try/download/shell
+- **MongoDB Tools**: https://www.mongodb.com/try/download/database-tools
+
+#### ui-styling
+- **Node.js 18+**: https://nodejs.org/
+- **pnpm**: `npm install -g pnpm`
+- **yarn**: `npm install -g yarn`
+
+## Installation by Platform
+
+### Linux (Ubuntu/Debian)
+
+```bash
+# Python environment
+python3 -m venv .venv
+source .venv/bin/activate
+
+# System tools
+sudo apt-get update
+sudo apt-get install -y ffmpeg imagemagick postgresql-client
+
+# Node.js and tools
+curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash -
+sudo apt-get install -y nodejs
+npm install -g pnpm wrangler repomix rmbg-cli
+```
+
+### macOS
+
+```bash
+# Python environment
+python3 -m venv .venv
+source .venv/bin/activate
+
+# System tools via Homebrew
+brew install ffmpeg imagemagick postgresql
+
+# Node.js and tools
+brew install node
+npm install -g pnpm wrangler repomix rmbg-cli
+```
+
+### Windows
+
+```powershell
+# Python environment
+python -m venv .venv
+.venv\Scripts\activate
+
+# System tools via Chocolatey
+choco install ffmpeg imagemagick nodejs
+
+# Node.js tools
+npm install -g pnpm wrangler repomix rmbg-cli
+```
+
+## Testing Dependencies
+
+All skills include test dependencies in `requirements.txt`:
+
+```txt
+pytest>=8.0.0
+pytest-cov>=4.1.0
+pytest-mock>=3.12.0
+```
+
+To run tests for a skill:
+
+```bash
+cd $HOME/.copilot/skills/{skill-name}/scripts
+python -m pytest tests/ -v --cov=. --cov-report=term-missing
+```
+
+## Environment Variables
+
+Skills respect environment variable loading priority:
+
+1. **process.env** (highest priority - runtime environment)
+2. **`$HOME/.copilot/skills/{skill-name}/.env`** (skill-specific config)
+3. **`$HOME/.copilot/skills/.env`** (shared skills config)
+4. **`$HOME/.copilot/.env`** (global config)
+
+Example `.env` files are provided where needed (e.g., `devops/.env.example`).
+
+## Troubleshooting
+
+### "externally-managed-environment" Error
+
+If you see this error when installing packages:
+
+```bash
+# Use virtual environment (recommended)
+python3 -m venv .venv
+source .venv/bin/activate
+pip install -r requirements.txt
+
+# Or use pipx for CLI tools
+pipx install google-genai
+```
+
+### Missing System Tools
+
+If scripts fail with "command not found":
+
+```bash
+# Check if tool is installed
+which ffmpeg
+which docker
+which node
+
+# Verify tool works
+ffmpeg -version
+docker --version
+node --version
+```
+
+### Permission Errors
+
+On Linux/macOS, you may need to make scripts executable:
+
+```bash
+chmod +x $HOME/.copilot/skills/*/scripts/*.py
+```
+
+## Minimal Installation
+
+If you only want to use specific skills:
+
+**For media processing tools only:**
+```bash
+# macOS
+brew install ffmpeg imagemagick
+npm install -g rmbg-cli
+
+# Linux
+sudo apt-get install ffmpeg imagemagick
+npm install -g rmbg-cli
+
+# Windows
+choco install ffmpeg imagemagick
+npm install -g rmbg-cli
+```
+
+**For other skills:**
+Most other skills (repomix, devops, ui-styling, databases) use only Python stdlib and require no `pip install`.
+
+## Development Setup
+
+For contributors working on skills:
+
+```bash
+# Install all test dependencies
+pip install pytest pytest-cov pytest-mock
+
+# Install pre-commit hooks (if available)
+pre-commit install
+
+# Run all tests
+pytest $HOME/.copilot/skills/*/scripts/tests/ -v
+
+# Check coverage across all skills
+pytest $HOME/.copilot/skills/*/scripts/tests/ --cov=.copilot/skills --cov-report=html
+```
+
+## Skill-Specific Notes
+
+### Media Processing Tools
+- FFmpeg must be in PATH
+- ImageMagick must be in PATH
+- RMBG CLI must be installed globally
+- Test with: `ffmpeg -version`, `convert -version`, and `rmbg --version`
+
+### devops
+- Cloudflare: Requires `CLOUDFLARE_API_TOKEN` and `CLOUDFLARE_ACCOUNT_ID`
+- GCloud: Requires `GOOGLE_APPLICATION_CREDENTIALS` path to service account JSON
+- Docker: Must have Docker daemon running
+
+## Getting Help
+
+If dependencies fail to install or scripts don't work:
+
+1. Check the skill's `scripts/requirements.txt` for specific versions
+2. Verify system tools are installed and in PATH
+3. Check environment variables are set correctly
+4. Review skill's `SKILL.md` for additional setup instructions
+5. Open an issue on the project repository

package/templates/repo/.github/skills/README.md

@@ -0,0 +1,112 @@
+# Skills
+Skills are folders of instructions, scripts, and resources that the AI agent loads dynamically to improve performance on specialized tasks. Skills teach the AI agent how to complete specific tasks in a repeatable way, whether that's creating documents with your company's brand guidelines, analyzing data using your organization's specific workflows, or automating personal tasks.
+
+# About This Repository
+
+This repository contains example skills that demonstrate what's possible with the skills system. These examples range from creative applications (art, music, design) to technical tasks (testing web apps, MCP server generation) to enterprise workflows (communications, branding, etc.).
+
+Each skill is self-contained in its own directory with a `SKILL.md` file containing the instructions and metadata that the AI agent uses. Browse through these examples to get inspiration for your own skills or to understand different patterns and approaches.
+
+The example skills in this repo are open source (Apache 2.0).
+
+**Note:** These are reference examples for inspiration and learning. They showcase general-purpose capabilities rather than organization-specific workflows or sensitive content.
+
+## Disclaimer
+
+**These skills are provided for demonstration and educational purposes only.** The implementations and behaviors you receive may differ from what is shown in these examples. These examples are meant to illustrate patterns and possibilities. Always test skills thoroughly in your own environment before relying on them for critical tasks.
+
+# Installation
+
+Some skills require external dependencies (FFmpeg, ImageMagick, Node.js packages, Python packages). Use our automated installation scripts to set up all dependencies:
+
+## Automated Installation (Recommended)
+
+**Linux/macOS:**
+```bash
+cd $HOME/.copilot/skills
+./install.sh
+```
+
+**Windows (PowerShell as Administrator):**
+```powershell
+cd .copilot\skills
+.\install.ps1
+```
+
+The installation scripts will:
+- Install system tools (FFmpeg, ImageMagick)
+- Install Node.js packages (rmbg-cli, pnpm, wrangler, repomix)
+- Create Python virtual environment
+- Install Python packages (google-genai, pypdf, Pillow, etc.)
+- Install test dependencies
+- Verify all installations
+
+## Manual Installation
+
+For manual installation or troubleshooting, see [INSTALLATION.md](INSTALLATION.md) for detailed instructions.
+
+## What Gets Installed
+
+- **System Tools**: FFmpeg, ImageMagick
+- **Node.js Packages**: rmbg-cli, pnpm, wrangler, repomix
+- **Python Packages**: google-genai, pypdf, python-docx, Pillow, pytest
+
+See [INSTALLATION.md](INSTALLATION.md) for complete dependency list and platform-specific instructions.
+
+# Example Skills
+
+This repository includes a diverse collection of example skills demonstrating different capabilities:
+
+## Creative & Design
+- **algorithmic-art** - Create generative art using p5.js with seeded randomness, flow fields, and particle systems
+- **canvas-design** - Design beautiful visual art in .png and .pdf formats using design philosophies
+- **slack-gif-creator** - Create animated GIFs optimized for Slack's size constraints
+
+## Development & Technical
+- **artifacts-builder** - Build complex HTML artifacts using React, Tailwind CSS, and shadcn/ui components
+- **mcp-server** - Guide for creating high-quality MCP servers to integrate external APIs and services
+- **webapp-testing** - Test local web applications using Playwright for UI verification and debugging
+
+## Enterprise & Communication
+- **brand-guidelines** - Apply brand colors and typography to artifacts
+- **internal-comms** - Write internal communications like status reports, newsletters, and FAQs
+- **theme-factory** - Style artifacts with 10 pre-set professional themes or generate custom themes on-the-fly
+
+# Using Skills
+
+You can use skills by mentioning them in conversation. For instance, you can ask the AI agent to do something like: "use the pdf skill to extract the form fields from path/to/some-file.pdf"
+
+# Creating a Basic Skill
+
+Skills are simple to create - just a folder with a `SKILL.md` file containing YAML frontmatter and instructions:
+
+```markdown
+---
+name: my-skill-name
+description: A clear description of what this skill does and when to use it
+---
+
+# My Skill Name
+
+[Add your instructions here that the AI agent will follow when this skill is active]
+
+## Examples
+- Example usage 1
+- Example usage 2
+
+## Guidelines
+- Guideline 1
+- Guideline 2
+```
+
+The frontmatter requires only two fields:
+- `name` - A unique identifier for your skill (lowercase, hyphens for spaces)
+- `description` - A complete description of what the skill does and when to use it
+
+The markdown content below contains the instructions, examples, and guidelines that the AI agent will follow.
+
+# Partner Skills
+
+Skills are a great way to teach the AI agent how to get better at using specific pieces of software. Here are some partner skills:
+
+- **Notion** - [Notion Skills](https://www.notion.so/notiondevs/Notion-Skills-28da4445d27180c7af1df7d8615723d0)