Skip to main content

A local project chat assistant with safe file tools and slash commands.

Project description

Local Project Chat Agent

An AI-powered command-line agent for exploring and analyzing local codebases using natural language and LLM-based tool calling. It provides safe access to files through built-in tools like ls, cat, grep, calculate, and compact.

doctests integration-tests flake8 coverage pypi


Demo

demo


Features

  • Safe local file inspection with path validation (prevents absolute paths and traversal attacks)
  • Manual slash commands (/ls, /cat, /grep, /calculate, /compact)
  • Automatic LLM-based tool calling
  • One-shot CLI usage
  • --debug flag to display tool calls
  • --provider flag for model selection
  • Full testing suite (doctests, integration tests, flake8, coverage)

Installation

pip install -r requirements.txt

Usage

python chat.py
python chat.py "what is 2 + 2?"
python chat.py --debug "what files are in the .github folder?"
python chat.py --provider groq "show me README.md"

Example: Webscraping Project

This example is good because it shows the agent answering a high-level question about a real scraping project.

$ cd test_projects/webscraping_project
$ python ../../chat.py "what is this project about?"
The project is designed to scrape product data from eBay listings, including titles, prices, and links.

Example: Markdown Compiler

This example is good because it shows the agent inspecting implementation details across source files.

$ cd test_projects/markdown_compiler
$ python ../../chat.py "find def in *.py"
def compile_markdown(file_path):
def parse_headers(text):
def render_html(content):

Example: Mia.Urosevic.github.io

This example is good because it shows the agent reading and summarizing files from a real webpage project.

$ cd test_projects/Mia.Urosevic.github.io
$ python ../../chat.py "show me README.md"
This project is a personal website built using HTML, CSS, and JavaScript.

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

lab_more_project_chat-0.1.0.tar.gz (11.6 kB view details)

Uploaded Source

Built Distribution

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

lab_more_project_chat-0.1.0-py3-none-any.whl (10.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for lab_more_project_chat-0.1.0.tar.gz
Algorithm Hash digest
SHA256 1c696d36e10e68c606d6ca203dd3898041a86146ea8117d728fafc58f13ffd7c
MD5 dde3d78a1d64d66bfb85743f119e90b8
BLAKE2b-256 d483d10e19931acb0f13f6ccf3a9ffa4825391b40544b0d0fc935d62d2f595e4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for lab_more_project_chat-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 013c791a3092cb3d03a4c1a0255e8f126d71c994dd3203f5ef515bcd3f057e99
MD5 ad590e15577f8f51a6e6f745649b5879
BLAKE2b-256 799798cf2f2bddf66e52ee1c6ec3625e638060e40b9b5a6f6c4d46bb71a9763e

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