Skip to content

Install & first run

import { Tabs, TabItem, Steps } from “@astrojs/starlight/components”;

You need Python 3.12+ and uv. That’s it.

Prerequisites

Terminal window
# Install uv
curl -LsSf https://astral.sh/uv/install.sh | sh
# Verify
uv --version
python3 --version # 3.12 or newer
Terminal window
# Install uv
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
# Verify
uv --version
python --version # 3.12 or newer

If python is older than 3.12, uv can install a managed 3.12 for you:

Terminal window
uv python install 3.12

Install Pixie

  1. Clone the repo.

    Terminal window
    git clone https://github.com/AlexKapadia/Pixie.git
    cd pixie
  2. Install dependencies. uv sync reads pyproject.toml and creates .venv/ in the repo root with everything Pixie needs.

    Terminal window
    uv sync
  3. Run Pixie.

    Terminal window
    uv run pixie

    You should see something like:

    Pixie listening on http://127.0.0.1:7860
    Discovered 12 tools in ./tools
  4. Open the dashboard. Browse to http://localhost:7860. The example tool (compound-interest) is already in the sidebar with a green dot.

What you should see on first run

  • A left sidebar listing every tool under tools/, grouped by category, with a coloured dot next to each name:
    • Green — validator passed, ready to run.
    • Yellow — validator warned (e.g. slow shutdown), still runnable.
    • Red — validator failed, clicking shows the report instead of spawning.
    • Grey — never spawned, not yet warm.
  • A header showing the active tool’s name, description, and a “running” / “dormant” pill.
  • A main area split by the tool’s declared layout (form, chat, or split).

If the sidebar is empty, see Troubleshooting → empty sidebar.

Next