Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.gofastskill.com/llms.txt

Use this file to discover all available pages before exploring further.

​
System Requirements

Before installing FastSkill, ensure your system meets these requirements:
ComponentMinimum VersionRecommended
OSmacOS, Linux, or WindowsLatest stable release
Memory512MB2GB+
Storage100MB500MB+
OpenAI API KeyOptionalRequired for embedding search / reindex with embeddings

​
CLI Installation

Pick one method. Homebrew (macOS and Linux) and Scoop (Windows) stay updated with releases; use GitHub Releases or the install script if you prefer a standalone binary.
Homebrew installs a pre-built fastskill on both Apple Silicon and Intel Macs, and on Linux where the tap ships bottles.
brew install gofastskill/cli/fastskill
fastskill -V
Details and formula updates live in the gofastskill/homebrew-cli tap repository.
If brew install fails with a tap error, run brew update and try again, or use the GitHub Releases or install script tab.
Skills Directory Resolution: The CLI automatically discovers the skills directory in this priority order:
  1. skills_directory setting in .fastskill/config.yaml
  2. Walk up directory tree to find existing .claude/skills/
  3. Default to .claude/skills/ in current directory
Manifests and lockfiles:
  • Declare skills in skill-project.toml at project root (with [dependencies] section)
  • Install with fastskill install (use --without/--only for groups)
  • Lockfile is written to skills.lock at project root after installs
  • Repository configuration is stored in [tool.fastskill.repositories] section of skill-project.toml

​
Configuration

After installation, configure FastSkill by creating .fastskill/config.yaml: 
embedding:
  openai_base_url: "https://api.openai.com/v1"
  embedding_model: "text-embedding-3-small"

# Optional: Custom skills directory
skills_directory: ".claude/skills"
Note: Service-level configuration (embedding settings) is stored in .fastskill/config.yaml. Project-level configuration (skill dependencies and repositories) is stored in skill-project.toml at your project root. Set your OpenAI API key: 
export OPENAI_API_KEY="your-key-here"

​
Docker (optional)

If you run tools in containers, install the same release archive inside your image (see the Linux steps above) or copy the fastskill binary into a minimal base image. Mount your project directory and set OPENAI_API_KEY when you use embedding search.

​
Platform notes

​
macOS

  • Recommended: Homebrew tab above (brew install gofastskill/cli/fastskill) for both Apple Silicon and Intel.
  • Without Homebrew: use the GitHub Releases tab for aarch64 vs x86_64 darwin archives, or the install script tab.

​
Linux

  • Recommended: Homebrew on Linux if you already use it, otherwise the GitHub Releases tab (gnu vs musl per release notes) or the install script.

​
Windows

  • Recommended: Scoop tab above.
  • Without Scoop: download the zip from GitHub Releases, extract, add to PATH.
  • WSL: install inside Ubuntu using the Linux or install-script options above.

​
Verify the CLI

fastskill -V
fastskill --help
If you already have a project with skill-project.toml, try fastskill list or fastskill install from that directory.

​
Troubleshooting

Homebrew: If the tap is missing, install with brew install gofastskill/cli/fastskill. See homebrew-cli for issues.
Scoop: Ensure the bucket was added (scoop bucket list should show gofastskill). See scoop-bucket if scoop install fastskill fails.
Binary not found in PATH: After extracting a release archive, move fastskill (or add the folder containing fastskill.exe) to a directory on your PATH (/usr/local/bin, ~/.local/bin, or Windows user PATH).
Permission denied (Linux): If you get permission errors, use sudo when moving to /usr/local/bin/, or install to ~/.local/bin/ instead and ensure it’s in your PATH.
Windows security warning: Windows may show a security warning for unsigned binaries. Click “More info” and then “Run anyway” if you trust the source.
Embedding configuration required: Create .fastskill/config.yaml with OpenAI API configuration.
OpenAI API key not found: Set OPENAI_API_KEY environment variable or configure in .fastskill/config.yaml.
macOS security: If you get security warnings, go to System Settings > Privacy & Security and allow the binary.
Windows antivirus: If Windows blocks the downloaded binary, add an exception for the folder where you keep fastskill.exe.
Still having issues? Check the troubleshooting section.