> ## 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.

# Quick Start Guide

> First skills with FastSkill in minutes: install, manifest, add, install, reindex, search, optional serve.

## Prerequisites

* The `fastskill` binary on your `PATH` (see [Installation](/installation): Homebrew on macOS/Linux, Scoop on Windows, or release archives)
* `OPENAI_API_KEY` when you use embedding search or `reindex`

## Five-minute setup (CLI)

<Steps>
  <Step title="Install the CLI">
    Follow [Installation](/installation), then confirm:

    ```bash theme={null}
    fastskill -V
    ```
  </Step>

  <Step title="Create a manifest">
    Create `skill-project.toml` at your project root:

    ```toml skill-project.toml theme={null}
    [dependencies]
    demo-skill = { source = "local", path = "./skills/demo-skill", editable = true, groups = ["dev"] }
    ```
  </Step>

  <Step title="Add a skill">
    Pick the source that matches your workflow:

    ```bash theme={null}
    # From a public registry ID
    fastskill add pptx@1.0.0

    # 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
    ```
  </Step>

  <Step title="Install & index">
    ```bash theme={null}
    fastskill install
    fastskill reindex
    ```
  </Step>

  <Step title="Search & verify">
    ```bash theme={null}
    fastskill search "text processing" --local --format json
    ```

    <Check>
      You should see JSON results for installed skills. If empty, run `fastskill install`, then `fastskill reindex`, and search again.
    </Check>
  </Step>

  <Step title="Optional: serve UI">
    ```bash theme={null}
    fastskill serve --port 8080
    ```

    Browse `http://localhost:8080/` for the bundled UI.

    The HTTP API is available under `/api/v1/…`, e.g.:

    * `GET http://localhost:8080/api/v1/skills` — list installed skills
    * `GET http://localhost:8080/healthz` — liveness probe
    * `GET http://localhost:8080/readyz` — readiness probe
  </Step>
</Steps>

## Use-case quick recipes

* **Install skills from different sources**
  * Public registry ID: `fastskill add pptx@1.0.0`
  * 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 Git marketplace:
    ```bash theme={null}
    fastskill repos add team --repo-type git-marketplace https://github.com/org/skills.git --priority 1
    fastskill install
    ```

* **Add standard-compliant skills (SKILL.md only)**

  ```bash theme={null}
  # Create minimal skill
  mkdir my-first-skill
  cd my-first-skill

  cat > SKILL.md << 'EOF'
  ---
  name: my-first-skill
  description: A simple skill following the AI Agentic Skills Standard
  ---

  This is my first skill!
  EOF

  # Add it to fastskill
  fastskill add .
  ```

  FastSkill will:

  * Extract the skill ID from SKILL.md (`name` or `metadata.id`)
  * Extract version from SKILL.md (`metadata.version` or `version`, defaulting to `1.0.0`)
  * Display a warning suggesting `fastskill init` to add `skill-project.toml`

## 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`).