Installation & Quick Start
Relevant source files
The following files were used as context for generating this wiki page:
- bundled-skills/wiki-onboarding/SKILL.md
- bundled-skills/readme/SKILL.md
- bundled-skills/documentation-templates/SKILL.md
- bundled-skills/skill-creator/SKILL.md
- bundled-skills/python-packaging/resources/implementation-playbook.md
- bundled-skills/wiki-vitepress/SKILL.md
- bundled-skills/writing-skills/references/standards/README.md
The OpenCode Skills Collection is a modular repository designed to provide high-quality, reusable agent "skills" for CLI-based AI tools. This guide outlines the standardized procedures for setting up the environment, installing existing skills, and creating new modular components. By following these protocols, developers can ensure that skills are correctly indexed and executable across various platforms like GitHub Copilot CLI, Claude Code, and Codex.
Sources: bundled-skills/writing-skills/references/standards/README.md, bundled-skills/skill-creator/SKILL.md:27-40
Prerequisites
Before installing or developing skills, the environment must be configured to support the specific directory structures required by AI agents.
Tool Compatibility
The skills in this collection target multiple platforms. Installation requirements vary depending on the target agent:
| Target Platform | Required Configuration Directory |
|---|---|
| GitHub Copilot CLI | ~/.copilot/skills/ |
| Claude Code | ~/.claude/skills/ |
| Codex | ~/.codex/skills/ |
| OpenCode Standard | ~/.config/opencode/skills/ |
Sources: bundled-skills/skill-creator/SKILL.md:46-56, bundled-skills/writing-skills/references/standards/README.md:5-10
Language Detection
The system automatically detects the primary language of a project to tailor installation instructions and code examples:
package.json-> TypeScript/JavaScriptpyproject.toml-> PythonCargo.toml-> Rustgo.mod-> Go
Sources: bundled-skills/wiki-onboarding/SKILL.md:21-28
Installation Workflow
Skills can be installed either locally within a repository or globally for system-wide access. The standard method involves creating symbolic links from the repository source to the agent's configuration directory.
Global Installation via Symlinks
This is the recommended method as it allows skills to update automatically when the central repository is updated.
Manual Setup
- Clone the repository:
git clone https://github.com/FrancoStino/opencode-skills-collection.git - Navigate to the skill: Choose a skill from the
bundled-skills/directory. - Create directory: Ensure the destination directory exists (e.g.,
mkdir -p ~/.copilot/skills). - Link the skill:
ln -sf $(pwd)/bundled-skills/skill-name ~/.copilot/skills/skill-name.
Sources: bundled-skills/skill-creator/SKILL.md:290-305, bundled-skills/writing-skills/references/standards/README.md:1-12
Creating a New Skill
The skill-creator tool automates the generation of new skills following best practices.
Skill Scaffolding Structure
A valid skill must follow a specific directory and file naming convention to be discoverable:
{skill-name}/ # kebab-case directory
SKILL.md # Main definition (ALL CAPS)
README.md # User-facing guide
references/ # Supporting docs
examples/ # Code samples
scripts/ # Utility scripts
Sources: bundled-skills/writing-skills/references/standards/README.md:5-15, bundled-skills/skill-creator/SKILL.md:195-205
Quick Start: Skill Generation
To create a new skill, the system follows a phased workflow:
Documentation Site Setup (VitePress)
For visual browsing, the wiki pages can be packaged into a VitePress static site.
Initialization
- Create Scaffold: Initialize a
wiki-site/directory with.vitepress/config.mts. - Configure Mermaid: Ensure the
withMermaidwrapper is used for architecture diagrams. - Build:
npm install && npm run docs:build
Sources: bundled-skills/wiki-vitepress/SKILL.md:17-30, bundled-skills/wiki-vitepress/SKILL.md:118-120
Formatting Requirements
- All
.mdfiles must include YAML frontmatter withtitleanddescription. - Generic parameters (e.g.,
<T>) must be escaped with backticks to prevent Vue template compiler errors. - Mermaid diagrams must be configured with specific hex codes for dark-mode compatibility (e.g., node fills
#2d333b).
Sources: bundled-skills/wiki-vitepress/SKILL.md:108-115, bundled-skills/wiki-page-writer/SKILL.md:52-60
Summary
Setting up the OpenCode Skills Collection requires configuring agent-specific directories and establishing symbolic links for global access. Developers can quickly contribute to the collection by using the provided scaffolding templates, ensuring all skills contain a mandatory SKILL.md file with valid YAML frontmatter. This modular approach ensures that every skill is a self-contained unit of knowledge, ready for deployment across multiple AI platforms.
Sources: bundled-skills/writing-skills/references/standards/README.md, bundled-skills/skill-creator/SKILL.md:320-335