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
pip install locus-cli
Or to run from source:
git clone https://github.com/Tech-Matt/locus.git
cd locus
python -m venv .venv
source .venv/bin/activate # Windows: `.venv\Scripts\activate`
pip install -e .
Usage
# Show a tree of the current directory
locus tree
# Show a tree of a specific path, with custom depth and ignore rules
locus tree /path/to/codebase --depth 3 --ignore build --ignore dist
# Print version
locus --version
Roadmap
- Recursive tree mapping with smart filtering and file caps
- Hardware profiling (Apple Silicon, NVIDIA, AMD, CPU-only detection)
-
locus treeCLI command (depth, max-files, ignore flags) - PyPI packaging (
pip install locus-cli) -
locus overview— static codebase stats (file counts, languages, largest folders) - Progressive rendering — stream tree output incrementally for large repos
- Local LLM summaries — auto-download and run architecture-optimized models
- TUI — full interactive terminal UI
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.0a2.tar.gz.
File metadata
- Download URL: locus_cli-0.1.0a2.tar.gz
- Upload date:
- Size: 13.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 |
7daa823228efa1a91acbbd958ad1c181337eaa3e705fd174fa7a12228ea6b2d3
|
|
| MD5 |
afaab6f4e3487d695993fc472b682ace
|
|
| BLAKE2b-256 |
0f2b7619af0bfc59607bf7be92f97d1d7db54ca69771fb0ea413bd33b14222b3
|
Provenance
The following attestation bundles were made for locus_cli-0.1.0a2.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.0a2.tar.gz -
Subject digest:
7daa823228efa1a91acbbd958ad1c181337eaa3e705fd174fa7a12228ea6b2d3 - Sigstore transparency entry: 1000992374
- Sigstore integration time:
-
Permalink:
Tech-Matt/locus@3c782a8c76f31f2c112ab172469e33bc77db17e7 -
Branch / Tag:
refs/tags/v0.1.0a2 - Owner: https://github.com/Tech-Matt
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@3c782a8c76f31f2c112ab172469e33bc77db17e7 -
Trigger Event:
push
-
Statement type:
File details
Details for the file locus_cli-0.1.0a2-py3-none-any.whl.
File metadata
- Download URL: locus_cli-0.1.0a2-py3-none-any.whl
- Upload date:
- Size: 12.3 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 |
03e4a7328d4b4acb5447a3b32668410622caca965030cdaf33092069ca5f8f08
|
|
| MD5 |
8ced2286e4bd2ee15215878d20f0a764
|
|
| BLAKE2b-256 |
9b84d772eaa08749bfbb327bcd7b97aa9dc0d34c3ca5ba81378d315265897e65
|
Provenance
The following attestation bundles were made for locus_cli-0.1.0a2-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.0a2-py3-none-any.whl -
Subject digest:
03e4a7328d4b4acb5447a3b32668410622caca965030cdaf33092069ca5f8f08 - Sigstore transparency entry: 1000992450
- Sigstore integration time:
-
Permalink:
Tech-Matt/locus@3c782a8c76f31f2c112ab172469e33bc77db17e7 -
Branch / Tag:
refs/tags/v0.1.0a2 - Owner: https://github.com/Tech-Matt
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@3c782a8c76f31f2c112ab172469e33bc77db17e7 -
Trigger Event:
push
-
Statement type: