Metadata-Version: 2.4
Name: SourceIndex
Version: 0.1.0
Summary: Codebase index for agentic coding
Requires-Python: >=3.10
Requires-Dist: cryptography>=42
Requires-Dist: keyring>=24
Requires-Dist: litellm>=1.50
Requires-Dist: tree-sitter-c>=0.23
Requires-Dist: tree-sitter-cpp>=0.23
Requires-Dist: tree-sitter-go>=0.23
Requires-Dist: tree-sitter-java>=0.23
Requires-Dist: tree-sitter-javascript>=0.23
Requires-Dist: tree-sitter-kotlin>=1.0
Requires-Dist: tree-sitter-ruby>=0.23
Requires-Dist: tree-sitter-rust>=0.23
Requires-Dist: tree-sitter-typescript>=0.23
Requires-Dist: tree-sitter>=0.23
Provides-Extra: mcp
Requires-Dist: mcp<2,>=1.0.0; extra == 'mcp'
Description-Content-Type: text/markdown

# Getting Started with sourceindex

Hey — and thank you! You're the very first person outside the team to try
sourceindex, and that genuinely means a lot. I'm really glad you're giving
it a go.

Anything you notice along the way — good, bad, broken, or just "huh, that's
weird" — would be hugely helpful to hear. No feedback is too small.

## What it is

When you ask a coding agent to fix or build something, it has to find the
relevant code first. By default Claude Code does that live, in your session.
`sourceindex` does it ahead of time so the agent jumps straight to the right
files.

**Best on an existing repo you didn't fully write yourself.** Not very useful
on a brand-new empty project.

## Install and set up

You'll need Python 3.10+ and a sourceindex API key (starts with `sk-si-`).
Ask me — I'll send you one.

**Easiest path:** open this file in Claude Code and tell it "set sourceindex
up in this repo." It can run the steps for you.

If you'd rather do it by hand:

```bash
pip install sourceindex
cd /path/to/your/repo
sourceindex init
```

It'll prompt for the key, set up some git hooks plus a Claude subagent, and
scan your repo. A few minutes, once per repo. If you don't have a `CLAUDE.md`
yet, run `/init` in Claude Code first.

## Day-to-day

Nothing. Open the repo in Claude Code as usual — it'll use sourceindex on
its own.

## Feedback I'd love

- Did `sourceindex init` finish cleanly?
- Does the agent feel different? Even "I can't tell" is useful.
- Anything in this doc that didn't land.

Thanks!
