Skip to content

Latest commit

 

History

History
92 lines (61 loc) · 3.15 KB

README.md

File metadata and controls

92 lines (61 loc) · 3.15 KB

Locify 🔎

PyPI - Python Versions PyPI - Package Version GitHub - License Docs - GitHub.io

Locify is a library designed to help LLM-based agents navigate and analyze large codebases efficiently. It leverages parsing techniques to provide insights into code structure and relationships.

Features

On a Git-based repository, Locify offers:

  • Codebase Skeleton Mapping:

    • FullMapStrategy: Generates a skeleton map of the entire codebase or a directory only.
    • RepoMapStrategy: Focuses on the reference relationships, using graph theory to rank and analyze code elements.

  • Tree-sitter Integration: Utilizes Tree-sitter for precise parsing of source code, supporting multiple programming languages.

  • Command-Line Interface: Provides a user-friendly CLI for executing different mapping strategies.

Installation

Locify can be installed via pip:

pip install locify

Usage

Command-Line Interface

Locify offers a CLI to execute mapping strategies:

python -m locify.cli <strategy> get_map_with_token_count [options]
  • <strategy>: Choose between fullmap and repomap.
  • [options]: Additional options for customizing the mapping process, e.g. file's depth, or specific directories only.

Example

  • To generate a full map of a codebase:

    python -m locify.cli fullmap get_map_with_token_count --root /path/to/gitrepo

  • To generate a full map of the locify directory only, with maximum depth of 3:

    python -m locify.cli fullmap get_map_with_token_count 3 locify

Development

Directory Structure

  • locify/: Main source code directory.
    • cli.py: Command-line interface implementation.
    • indexing/: Contains strategies for code mapping.
      • full_map/: Implementation of FullMapStrategy.
      • repo_map/: Implementation of RepoMapStrategy.
    • tree_sitter/: Tree-sitter integration for parsing.
      • parser.py: Tree-sitter parser implementation.
      • queries/: Schema query files for different languages.
    • utils/: Utility functions and classes.

Testing

Tests are located in the tests directory. Run tests using:

poetry run pytest

Acknowledgements

This project was inspired by the aider's RepoMap implementation.

License

This project is licensed under the terms of the MIT license. See the LICENSE file for details.