DevWayfinder

AI-powered developer onboarding guide generator.

Quick Start

1. Install (from source)

git clone https://github.com/IMAGINARY9/DevWayfinder.git
cd DevWayfinder
python -m venv .venv
# Windows PowerShell
.\.venv\Scripts\Activate.ps1
pip install -e ".[dev]"

2. Verify Provider (optional)

devwayfinder test-model --provider ollama --model mistral:7b

3. Generate Guide

devwayfinder guide ./my-project --auto
# quick offline mode:
# devwayfinder guide ./my-project --quality minimal --no-llm

---

Core Commands

• devwayfinder analyze <path>
• devwayfinder guide <path>
• devwayfinder generate <path>
• devwayfinder test-model
• devwayfinder init

---

Status

• MVP 1: complete
• MVP 2: complete
• MVP 2.5: complete
• MVP 3: in progress

See roadmap details in docs/IMPLEMENTATION_PLAN.md.

---

Documentation (Authoritative)

• Architecture: docs/ARCHITECTURE.md
• Requirements: docs/REQUIREMENTS.md
• Roadmap and milestone status: docs/IMPLEMENTATION_PLAN.md
• Configuration: docs/CONFIGURATION.md
• Provider setup and runtime usage: docs/USAGE.md
• Development and contribution standards: docs/CONTRIBUTING.md
• Performance benchmarks: docs/PERFORMANCE.md

---

License

MIT - see LICENSE.