Lightweight terminal app to quickly understand large codebases
Project description
LOCUS 🗺️
The free, 100% private, local-LLM codebase cartographer for your terminal.
Stop paying for expensive API keys just to understand a codebase. Locus is a lightweight terminal tool that automatically downloads and runs architecture-optimized local LLMs to instantly map and summarize large codebases—for free, and 100% privately.
Why Locus?
I wanted a tool to explore new and large codebases (like the Linux Kernel source code 😄), with an intuitive and powerful UI. Locus provides instant visual overviews and directory trees right in your terminal, helping you map out the structure before you deep dive into the code.
Free, Open, Local Intelligence
You shouldn't have to pay for expensive Gemini, Claude, or OpenAI API keys just to understand a codebase. Locus dynamically profiles your PC's hardware (Apple Silicon, NVIDIA, AMD GPU, or CPU-only) and automatically downloads and runs architecture-optimized local LLMs. You get instant and private folder summaries running entirely on your own machine—for free. (Cloud APIs are still supported if you prefer them).
- Zero-Friction: Just do
pip install locus-cliand runlocus. No Docker, no manual model downloading. (Still to be packaged as of now) - Fast & Native: A fast TUI built with
TextualandRich. - Private by Default: Your proprietary code never leaves your machine unless you explicitly configure a cloud provider.
Current Platform Support
- macOS (Apple Silicon / arm64): Supported
- macOS (Intel / x86_64): Not supported yet
- Linux: Supported
- Windows: Supported
Installation
Note: Locus is currently in active development. A v0.1 release is coming soon!
git clone https://github.com/Tech-Matt/locus.git
cd locus
python -m venv myEnv
source myEnv/bin/activate # Windows: `myEnv\Scripts\activate`
pip install -r requirements.txt
python main.py
Usage
Run locus in any directory you want to explore:
cd /path/to/massive/codebase
locus
Keybindings:
j/k: Scroll Down / Upd: Toggle Dark/Light Modeq: Quit LocusA: (Coming Soon) Generate a quick summary for the selected folder
Roadmap
- Phase 1: Visual Engine (Recursive parsing, smart filtering, TUI scaffolding)
- Phase 2: Hardware Profiling (Native GPU/RAM detection, model mapping)
- Phase 3: Local Summaries (Local inference engine, TUI integration)
- Phase 4: Testing & Hardening (Unit tests, CI/CD pipeline)
- Phase 5: Packaging (PyPI release, zero-dependency binaries)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file locus_cli-0.1.0a1.tar.gz.
File metadata
- Download URL: locus_cli-0.1.0a1.tar.gz
- Upload date:
- Size: 10.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e82bfdc320b6ec0718c4073b5925e4f0fc9c1f473e2624971a0c1413f1d68fab
|
|
| MD5 |
9a716f2444c2ab80130fca22c64b6058
|
|
| BLAKE2b-256 |
f89daa32e461b1f9201c0a4d4917e279ccaa8ef7e8e47f0e8adb406839364069
|
Provenance
The following attestation bundles were made for locus_cli-0.1.0a1.tar.gz:
Publisher:
publish.yml on Tech-Matt/locus
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
locus_cli-0.1.0a1.tar.gz -
Subject digest:
e82bfdc320b6ec0718c4073b5925e4f0fc9c1f473e2624971a0c1413f1d68fab - Sigstore transparency entry: 991623623
- Sigstore integration time:
-
Permalink:
Tech-Matt/locus@15ae378f79d63732e9ef0988625614f6b9c71fbe -
Branch / Tag:
refs/tags/v0.1.0a1 - Owner: https://github.com/Tech-Matt
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@15ae378f79d63732e9ef0988625614f6b9c71fbe -
Trigger Event:
push
-
Statement type:
File details
Details for the file locus_cli-0.1.0a1-py3-none-any.whl.
File metadata
- Download URL: locus_cli-0.1.0a1-py3-none-any.whl
- Upload date:
- Size: 10.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
49dc03cca880d6160bb9bdccb159e1713b4c5a13df3c85fbd5de22f82a6b6a14
|
|
| MD5 |
14d945ca879856c9e1161f872404fc47
|
|
| BLAKE2b-256 |
01aa3f613caaffbbc24e01dd128a3519368bf96f01f483846c7cd479e1d0ae9b
|
Provenance
The following attestation bundles were made for locus_cli-0.1.0a1-py3-none-any.whl:
Publisher:
publish.yml on Tech-Matt/locus
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
locus_cli-0.1.0a1-py3-none-any.whl -
Subject digest:
49dc03cca880d6160bb9bdccb159e1713b4c5a13df3c85fbd5de22f82a6b6a14 - Sigstore transparency entry: 991623625
- Sigstore integration time:
-
Permalink:
Tech-Matt/locus@15ae378f79d63732e9ef0988625614f6b9c71fbe -
Branch / Tag:
refs/tags/v0.1.0a1 - Owner: https://github.com/Tech-Matt
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@15ae378f79d63732e9ef0988625614f6b9c71fbe -
Trigger Event:
push
-
Statement type: