Skip to main content

Prerequisites

  • Rust 1.70+ and cargo
  • OpenAI API key (required for semantic search/reindex)

Five-minute setup (CLI)

1

Install the CLI

cargo install fastskill --features git-support
fastskill --version
2

Create a manifest

Create skill-project.toml at your project root:
skill-project.toml
[dependencies]
demo-skill = { source = "local", path = "./skills/demo-skill", editable = true, groups = ["dev"] }
3

Add a skill

Pick the source that matches your workflow:
# From a public registry ID
fastskill add [email protected]

# From a local folder (editable for dev)
fastskill add ./skills/demo-skill -e --group dev

# From git with a branch
fastskill add https://github.com/org/skill.git --branch main
4

Install & index

fastskill install
fastskill reindex
5

Search & verify

fastskill search "text processing" --format json
You should see a JSON list of matching skills. If empty, add a skill and rerun fastskill reindex.
6

Optional: serve UI

fastskill serve --enable-registry --port 8080
Browse http://localhost:8080/registry to view installed/available skills.

Use-case quick recipes

  • Install from sources
    • Public registry ID: fastskill add [email protected]
    • Local folder (editable): fastskill add ./skills/my-skill -e --group dev
    • Git repo with branch: fastskill add https://github.com/org/skill.git --branch main
    • Private registry:
      fastskill registry add team --type git-marketplace --url https://github.com/org/skills.git \
        --priority 1
      fastskill install
      
  • Package skills
    fastskill package --skills my-skill --output ./artifacts --bump patch
    

Troubleshooting

  • No skills found: ensure skill-project.toml exists at project root and rerun fastskill install.
  • Search returns nothing: run fastskill reindex after adding or installing skills.
  • Binary not on PATH: reinstall or move the binary to a directory in PATH (e.g., ~/.local/bin).