Skip to content

getting-started.md

Latest commit

 

History

History
161 lines (117 loc) · 2.58 KB

getting-started.md

File metadata and controls

161 lines (117 loc) · 2.58 KB

Getting Started

Installation

From PyPI

pip install capacium

From GitHub

pip install git+https://github.com/Capacium/capacium.git

Via Homebrew

brew install capacium/tap/capacium

From Source

git clone https://github.com/Capacium/capacium.git
cd capacium
pip install -e .

Verify Installation

cap --version
cap --help

Quickstart

1. Create a Capability

Create a directory with a capability.yaml manifest:

mkdir my-skill
cd my-skill
# capability.yaml
kind: skill
name: my-skill
version: 1.0.0
description: A simple example skill
author: Your Name
license: Apache-2.0

frameworks:
  - opencode

Add your skill content:

echo "You are a helpful assistant." > prompt.md

2. Install the Capability

cap install my-skill --source .

3. Verify Installation

cap list
cap verify my-skill

4. Package for Distribution

cap package . --output my-skill.tar.gz

5. Search the Registry

cap search code-review
cap search --kind skill --registry https://registry.capacium.dev/v1

Examples

Installing from Git

cap install https://github.com/user/my-cap.git

Installing a Specific Version

cap install owner/my-cap@1.2.0

Listing with Filters

cap list --kind skill

Removing a Capability

cap remove my-skill

Generating a Lock File

cap lock my-skill
cap lock my-skill --update

Installing Without Lock Enforcement

cap install my-skill --no-lock

Filesystem Layout

~/.capacium/
├── cache/                    # Central capability cache
│   ├── my-skill/
│   │   ├── 1.0.0/
│   │   └── 1.1.0/
│   └── code-reviewer/
│       └── 1.2.0/
├── active/                   # Active installation symlinks
│   ├── my-skill -> ../cache/my-skill/1.0.0
│   └── code-reviewer -> ../cache/code-reviewer/1.2.0
├── packages/                 # Storage manager package dirs
│   └── global/
│       └── my-skill/
│           └── 1.0.0/
├── keys/                     # Signing keys
│   ├── mykey.key
│   └── mykey.pub
└── registry.db               # SQLite registry database

Next Steps