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 generate ./my-project --no-llm
# or
# devwayfinder generate ./my-project --model-provider openai_compat --base-url http://127.0.0.1:5000/v1

Core Commands

  • devwayfinder analyze <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.9.tar.gz (128.0 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.9-py3-none-any.whl (103.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: devwayfinder-0.3.9.tar.gz
  • Upload date:
  • Size: 128.0 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.9.tar.gz
Algorithm Hash digest
SHA256 8a08218762bbd0a42010bd7e96789b881006175257b992242bc21e4af5af0c0a
MD5 cbdf585eccbf9b6a36c6244416b7a620
BLAKE2b-256 98180aa8dce67ec496a505586da2e71418f9210c8606d4aaf5ead30cef27821e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: devwayfinder-0.3.9-py3-none-any.whl
  • Upload date:
  • Size: 103.7 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.9-py3-none-any.whl
Algorithm Hash digest
SHA256 fbbf3010cc8fbe2d3facd766eeadf33aea3b7927b9b5ca8cbf7198f4500d0c0f
MD5 672d6ebd164f6c09c38c8628191283a6
BLAKE2b-256 159cc0cdf246d185babbc06be97514956b31e0fc701a83109fa256a2691e2178

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