Skip to main content

Codebase index for agentic coding

Project description

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:

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!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sourceindex-0.1.0.tar.gz (94.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sourceindex-0.1.0-py3-none-any.whl (117.2 kB view details)

Uploaded Python 3

File details

Details for the file sourceindex-0.1.0.tar.gz.

File metadata

  • Download URL: sourceindex-0.1.0.tar.gz
  • Upload date:
  • Size: 94.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for sourceindex-0.1.0.tar.gz
Algorithm Hash digest
SHA256 09cf6585713a3f2ac799487095703cc4511b32d5380162bc88f96e5213c84e44
MD5 99c6ac6ad4bc89d3e5165b90fdc45002
BLAKE2b-256 71da886b11a4d923fcf001bffb3f7fc50d85d7a703383fa7a10422d7687a548f

See more details on using hashes here.

File details

Details for the file sourceindex-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: sourceindex-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 117.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for sourceindex-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 dc840446097bb93f768ec442d704971923b603fe19c801adb47dc42e994074ff
MD5 857bc6e4788f6ef98c77012ff95f56be
BLAKE2b-256 58cf507c824ffbbac6cee12ada8b3f5369ea61c315d05d8bde561ebb3ca7ac31

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page