Skip to main content

VibeDir

VibeDir is a utility to facilitate code modifications by integrating with prepdir and applydir. It generates prompts for large language models (like Grok 3) to modify a codebase, producing a modified_prepped_dir.txt file that can be applied to update your project. VibeDir supports both manual workflows and future API integration with Grok 3.

Functionality is "COMING SOON"

Features

  • Generate prompts for code changes based on prepped_dir.txt from prepdir.
  • Support manual editing or API-driven workflows.
  • Preserve the structure of prepped_dir.txt for compatibility with applydir.
  • Configurable via a YAML file for custom prompt templates and logging.

Installation

pip install vibedir

Usage

  1. Generate a prepped_dir.txt file using prepdir (requires prepdir installed):
    prepdir --output prepped_dir.txt
    
  2. Use vibedir to create a prompt for Grok 3 or another LLM:
    vibedir prepped_dir.txt --request "Refactor test_file.py to use async functions" --output modified_prepped_dir.txt --manual
    
    • This outputs a prompt to copy into Grok 3. Save the response as modified_prepped_dir.txt.
  3. Apply changes using applydir (requires applydir installed):
    applydir modified_prepped_dir.txt
    

Configuration

VibeDir uses a vibedir.yaml file for settings. Example:

logging:
  level: INFO
prompt_template: |
  You are a code modification assistant. Below is the content of a prepped_dir.txt file generated by prepdir, listing files and additional commands for a project. Your task is to apply the following changes: {user_request}. Return the modified content in a file named modified_prepped_dir.txt, preserving the original format, including delimiters (e.g., =-=, ===---===), file markers (Begin File, End File), and additional commands section. Ensure filenames in Begin File and End File markers match exactly, and only include valid code changes.

  === prepped_dir.txt Content ===
  {prepped_dir_content}
  === End prepped_dir.txt Content ===

  Output the modified content as modified_prepped_dir.txt with the same structure.

Development

  • Clone the repository: git clone https://github.com/eyecantell/vibedir
  • Install with PDM: pdm install -G test
  • Run tests: pdm run pytest
  • Build and publish: pdm build && pdm publish

License

MIT License. See LICENSE for details.

Contributing

Issues and PRs are welcome at https://github.com/eyecantell/vibedir.

Metadata

Release files for vibedir 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for vibedir 0.1.0
File Size Uploaded Provenance
vibedir-0.1.0.tar.gz 3.5 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for vibedir 0.1.0
File Interpreter ABI Platform
vibedir-0.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 6.2 kB

Release files / vibedir-0.1.0.tar.gz

Download URL vibedir-0.1.0.tar.gz
Size 3.5 kB
Tags Source
SHA-256 checksum
How to use checksums
083c729ab23efd00ef5c8d73fbe2343dbaf5cdc22edd4c779245f57d2b2fe3a7
BLAKE2b-256 checksum
How to use checksums
60f802b846ea8200bab544b30644e86950f3f1aa90b1d1a2d485e20be9121b64
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via pdm/2.24.2 CPython/3.10.16 Linux/5.15.167.4-microsoft-standard-WSL2

Release files / vibedir-0.1.0-py3-none-any.whl

Download URL vibedir-0.1.0-py3-none-any.whl
Size 2.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f52a2f0fe4c508b21a96b4e0da38550f7c45cd932b552171723e1f56584a0f3d
BLAKE2b-256 checksum
How to use checksums
57a81ae6366c00a51a5dfdbed3663cae49b6b77426c40aec8a93d4fe88528fa5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via pdm/2.24.2 CPython/3.10.16 Linux/5.15.167.4-microsoft-standard-WSL2

Security for vibedir 0.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page