This release has been yanked by its maintainers, and will be ignored by installers, except when explicitly specified.
Consider using release 0.2.0 instead.
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, opencode, and Codex do 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-).
Apply for access at https://sourceindex.dev/access.
Easiest path: open this file in Claude Code, opencode, or Codex and tell it "set sourceindex up in this repo." It can run the steps for you.
If you'd rather do it by hand:
pip install sourceindex
cd /path/to/your/repo
sourceindex init # auto-detects your agent(s)
sourceindex init claude # set up Claude Code only
sourceindex init opencode # set up opencode only
sourceindex init codex # set up Codex only
It'll prompt for the key, set up some git hooks plus a subagent for the
coding agent your repo already uses (a CLAUDE.md or .claude/ means
Claude Code; a .opencode/ means opencode; a .codex/ means Codex; an
AGENTS.md alone means both opencode and Codex; none of those means Claude
Code), and scan your repo. A few minutes, once per repo. You can also name
several at once (sourceindex init claude opencode codex), and it's safe
to re-run init later to add another agent.
If you don't have a CLAUDE.md (Claude Code) or AGENTS.md (opencode,
Codex) yet, run /init in your agent first.
To replace a rotated or expired key later:
sourceindex api-key set
That prompts for the new key and persists it as your user-level default. New
repos and repos without a local override will use it automatically. For
automation, use
sourceindex api-key set --from-env with SOURCEINDEX_API_KEY already set,
pass --api-key sk-si-..., or pass the key positionally:
sourceindex api-key set sk-si-....
To set a repo-local override:
sourceindex api-key set --local
Explicit environment variables still win, and a repo-local key overrides the global default.
Day-to-day
Nothing. Open the repo in Claude Code, opencode, or Codex as usual — it'll use SourceIndex on its own.
Feedback I'd love
- Did
sourceindex initfinish cleanly? - Does the agent feel different? Even "I can't tell" is useful.
- Anything in this doc that didn't land.
More about the project lives at https://sourceindex.dev, and you can reach us any time at hi@sourceindex.dev.
Thanks!
Release files for SourceIndex 0.1.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sourceindex-0.1.4.tar.gz | 130.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sourceindex-0.1.4-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 286.2 kB
Release files / sourceindex-0.1.4.tar.gz
| Download URL | sourceindex-0.1.4.tar.gz |
|---|---|
| Size | 130.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3ba8ca9d8be5f76969bbf17445601c2ce8dcabea0289f7f7647dba56fe4c047c
|
|
BLAKE2b-256 checksum How to use checksums |
94737dcd56fa64ed56d5e8825c2fc522e7d23f804a3607e5dbf20a5643552148
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.10.8 {"installer":{"name":"uv","version":"0.10.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"22.04","id":"jammy","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
Release files / sourceindex-0.1.4-py3-none-any.whl
| Download URL | sourceindex-0.1.4-py3-none-any.whl |
|---|---|
| Size | 155.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ccaf2441a9d9b537aceee6991fdad9e63853b0e13f1d598f3d4140d5fb9a9339
|
|
BLAKE2b-256 checksum How to use checksums |
7afbf5d10cf0e358bc0677404ea329ea3a8237f7bbf92bece8086703002ee59d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.10.8 {"installer":{"name":"uv","version":"0.10.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"22.04","id":"jammy","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|