cmc-csci040-andrewvankomen 0.2.0

No project description provided

docsum AI chat tool

A command-line AI chat tool that lets you have conversations with your codebase. Point it at any project and ask questions. It can read files, search for patterns, list directories, and write files automatically.

Examples

The examples below show how to use chat with real projects. Run chat --help for a full list of options.

eBay Scraper

This example shows how /ls loads the file list into context so the LLM can answer questions without making an extra tool call.

$ cd test_projects/ebay_scraper
$ chat
chat> /ls .
__pycache__
ebay-dl.py
hammer.csv
hammer.json
laptop.csv
laptop.json
stuffed_animal.csv
stuffed_animal.json
chat> what does this project scrape?
The script scrapes eBay search result pages, extracting each listing's name, price, status, shipping cost, free-returns flag, and number of items sold. It outputs the collected data to JSON (or CSV).

Markdown Compiler

This example shows automatic tool use where the LLM reads the README on its own to answer the question.

$ cd test_projects/markdown_compiler
$ chat
chat> what does this project do?
It's a simple command-line tool that reads a Markdown file and compiles it into an HTML document, optionally adding a CSS stylesheet for nicer formatting.

Webpage

This example shows automatic tool use where the LLM calls grep on its own to answer the question.

$ cd test_projects/webpage
$ chat
chat> what pages does this website link to?
- **style.css** (stylesheet)
- **index.html** (the fanpage itself)
- **nfcwest.html** (NFC West Guide)
- **2021superbowl.html** (2021 Superbowl)
- **https://github.com/mikeizbicki/cmc-csci040** (CSCI040 course webpage)
- **https://izbicki.me/** (Mike Izbicki's personal webpage)
- **https://sophia09zheng13.github.io/** (Sophia's webpage)

Agent Examples

The examples below demonstrate the agent's ability to create, modify, and delete files, with all changes automatically committed to git.

Creating a file

The session below shows the agent creating a new Python file and automatically committing it to git.

$ ls -a
.git  AGENTS.md  README.md  chat.py  tools/
$ git log --oneline
c21103f (HEAD -> project4) init commit
$ chat
chat> create a python file called hello.py that prints "hello world"
Created hello.py with a simple hello world program.
chat> ^C
$ ls -a
.git  AGENTS.md  README.md  chat.py  hello.py  tools/
$ git log --oneline
3cfb0a6 (HEAD -> project4) [docchat] create hello world python file
c21103f init commit

Modifying a file

The session below shows the agent modifying an existing file and committing the change.

$ chat
chat> update hello.py to also print "goodbye world"
Updated hello.py to print both hello world and goodbye world.
chat> ^C
$ cat hello.py
print("hello world")
print("goodbye world")
$ git log --oneline
7a3b2c1 (HEAD -> project4) [docchat] update hello.py
3cfb0a6 [docchat] create hello world python file
c21103f init commit

Deleting a file

The session below shows the agent deleting a file and committing the deletion.

$ chat
chat> delete hello.py
Deleted hello.py and committed the change.
chat> ^C
$ ls -a
.git  AGENTS.md  README.md  chat.py  tools/
$ git log --oneline
9d4e5f2 (HEAD -> project4) [docchat] rm hello.py
7a3b2c1 [docchat] update hello.py
3cfb0a6 [docchat] create hello world python file
c21103f init commit