Skip to content

blackopsrepl/chewbekka

Repository files navigation

Chewbekka

Chewbekka is a Rust utility that extracts and summarizes Markdown files from a specified directory. It allows for both recursive and non-recursive extraction of Markdown files, implementing size limits and basic error handling. Features async bindings to local Ollama model.

Requirements

  • Ollama

Features

  • Summarize

    • Recursively extract Markdown files from a specified directory
    • Summarize each file
    • Summarize all summaries
  • Expand

    • Recursively extract Markdown files from a specified directory, assuming they will be documentation for a due task
    • Generate a task list for each file
    • Summarize into on task list
  • Debloat

    • Recursively extract Markdown files from a specified directory
    • Detect subtleties and demistify corporate and marketing jargon

Installation

To build and run Chewbekka, make sure you have Rust and Cargo installed. You can install them from rustup.rs.

Clone the repository and navigate into it:

git clone <repository-url>
cd chewbekka

Then, build the project:

cargo build --release

Usage

Chewbekka is used via the command line. The basic command structure is as follows:

chewbekka summarize <path>

Arguments

  • <path>: The path to the directory containing Markdown files you wish to summarize.

Example

chewbekka summarize /path/to/markdown/files

Testing

The program includes unit tests to ensure functionality. You can run the tests with:

cargo test

License

This project is licensed under the MIT License - see the LICENSE file for details.

About

Generative CLI tool that processes Markdown documentation.

Resources

License

Stars

Watchers

Forks

Packages

No packages published