Simple CLI tool to generate context for LLMs from codebase
Project description
✨ vibe — generate structured LLM context from your codebase in one command
Instead of manually opening files, copy-pasting their contents one by one, adding markdown formating,
describing every file, and stitching them into a prompt, vibe does it for you in a single command.
vibe collects files from a given directory, processes their contents, and forms a structured markdown context.
By default, the generated context is copied directly into your clipboard, so you can simply Ctrl+V it into your LLM prompt without any extra steps.
It respects git and considers .gitignore file.
Usage
Run vibe path/to/codedir/you/wanna/discuss/with/AI and the full structured description of all files and folders will be ready in your clipboard;)
The help reference:
$ vibe --help
Usage: vibe [OPTIONS] [PATH]
Form LLM context from a specified directory or file.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ path [PATH] Path to dir/file you want to make the context from. │
│ [default: /home/sky/Github/vibe] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --print -P Print the context instead of copying it to │
│ the clipboard. │
│ --version -V Show version and exit. │
│ --install-completion Install completion for the current shell. │
│ --show-completion Show completion for the current shell, to │
│ copy it or customize the installation. │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Installation
Just pip install show-me-your-vibe.
For MacOS and Windows it will work right out of the box.
For Linux (for accessing your clipboard) install a support lib accrding to the table below:
| Display Server | Family / Distribution | Command |
|---|---|---|
| Wayland (Commonly default) |
Ubuntu | Debian | Linux Mint | Pop!_OS | KDE Neon | elementary | sudo apt install wl-clipboard |
| Fedora | RHEL | CentOS | Rocky | AlmaLinux | Oracle Linux | sudo dnf install wl-clipboard |
|
| Arch | Manjaro | EndeavourOS | Garuda | sudo pacman -S --needed wl-clipboard |
|
| openSUSE Leap | Tumbleweed | SLES | sudo zypper install wl-clipboard |
|
| Alpine | sudo apk add wl-clipboard |
|
| Void | sudo xbps-install -S wl-clipboard |
|
| Gentoo | sudo emerge wl-clipboard |
|
| NixOS | Nix | nix-env -iA nixpkgs.wl-clipboard |
|
| X11 | Ubuntu | Debian | Linux Mint | Pop!_OS | KDE Neon | elementary | sudo apt install xclip or sudo apt install xsel |
| Fedora | RHEL | CentOS | Rocky | AlmaLinux | Oracle Linux | sudo dnf install xclip or sudo dnf install xsel |
|
| Arch | Manjaro | EndeavourOS | Garuda | sudo pacman -S --needed xclip or sudo pacman -S --needed xsel |
|
| openSUSE Leap | Tumbleweed | SLES | sudo zypper install xclip or sudo zypper install xsel |
|
| Alpine | sudo apk add xclip or sudo apk add xsel |
|
| Void | sudo xbps-install -S xclip or sudo xbps-install -S xsel |
|
| Gentoo | sudo emerge xclip or sudo emerge xsel |
|
| NixOS | Nix | nix-env -iA nixpkgs.xclip or nix-env -iA nixpkgs.xsel |
|
| No GUI | No system clipboard available - use xvfb, or write to file, or just print. |
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file show_me_your_vibe-0.1.0.tar.gz.
File metadata
- Download URL: show_me_your_vibe-0.1.0.tar.gz
- Upload date:
- Size: 7.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/2.1.4 CPython/3.12.3 Linux/6.14.0-28-generic
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4df30fa1ff82252900c61cd46c10311f77e910c1d2f6be1f9ef79222b5f0868f
|
|
| MD5 |
9f98bf71e95067e4921018dff16707a4
|
|
| BLAKE2b-256 |
3b96f09a9eb199f5faed8cdcad4351fc775758a6b343b1c57882a83e15e660b8
|
File details
Details for the file show_me_your_vibe-0.1.0-py3-none-any.whl.
File metadata
- Download URL: show_me_your_vibe-0.1.0-py3-none-any.whl
- Upload date:
- Size: 9.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/2.1.4 CPython/3.12.3 Linux/6.14.0-28-generic
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
284e87c2538a68c2a3148a8399dfa81b76b109e71734aa3bda1f9e225f8e8c6d
|
|
| MD5 |
d63cd960f3434cbe983e5730d6d6bdfe
|
|
| BLAKE2b-256 |
a77e909a542f27953f15601e904020ca77897b064c211d8df603cf85a413226e
|