Skip to main content

AI-Powered Developer Onboarding Generator

Project description

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)


License

MIT - see LICENSE.

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

devwayfinder-0.3.10.tar.gz (157.5 kB view details)

Uploaded Source

Built Distribution

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

devwayfinder-0.3.10-py3-none-any.whl (124.8 kB view details)

Uploaded Python 3

File details

Details for the file devwayfinder-0.3.10.tar.gz.

File metadata

  • Download URL: devwayfinder-0.3.10.tar.gz
  • Upload date:
  • Size: 157.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for devwayfinder-0.3.10.tar.gz
Algorithm Hash digest
SHA256 63966ee8dc3bff79ac47fe3725db607e28e3335f840a451ac33dcaf33010974e
MD5 e003f1bcf28d8807ed194430b1196ea2
BLAKE2b-256 440940912759c24e9eb53bb0463ba7c4a167f55fe8fdc9790e7067cf6951c24c

See more details on using hashes here.

File details

Details for the file devwayfinder-0.3.10-py3-none-any.whl.

File metadata

  • Download URL: devwayfinder-0.3.10-py3-none-any.whl
  • Upload date:
  • Size: 124.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for devwayfinder-0.3.10-py3-none-any.whl
Algorithm Hash digest
SHA256 05dbb5fe819188cb1b320df3ced0b622aaa41cb9ab42cd425c4994a71bee0d28
MD5 c8baddf78e4241a4104b38a8e43dc5ac
BLAKE2b-256 33880b9c5ba99d24d25b1e5cc41f9eb1ef292f22964c505935629a7c7ae0baf2

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