A web-based tool that processes markdown notes using sequential LLM-powered agent pipelines to enforce formatting, grammar, tagging, and content enhancement guidelines.
- Project Idea - Original concept and objectives
- Requirements Specification - Detailed functional and non-functional requirements
- Project Report - Implementation status and outcomes
- Development Guidelines - Coding standards and best practices
- Backend README - CLI usage, installation, and examples
- CLI Documentation - Command-line interface details
- Technical Documentation - Architecture and implementation details
- Test Guidelines - Testing standards and procedures
- Sample Notes - Example markdown files for testing
-
Clone and Setup
cd src/backend python -m pip install -r requirements.txt -
Configure Environment
cp .env.example .env # Edit .env with your LLM provider settings -
Run CLI Example
python src.backend.app.adapters.cli.agent_cli execute grammar --text "Your markdown text here"
This project implements a hexagonal architecture with:
- Domain Models: Agent, LLMProvider, AgentResult entities
- Provider Factory: LLM provider abstraction (OpenAI, LM Studio)
- Pipeline Engine: Sequential agent execution
- CLI Adapter: Command-line interface for processing
- Grammar: Corrects grammatical errors
- Tag: Adds semantic tags to content
- Link: Processes and validates links
See the backend documentation for detailed development instructions, testing procedures, and usage examples.
See LICENSE file for details.