✨ 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 formatting, 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 printed to stdout, so you can pipe it or redirect it to a file.
With -c/--copy it goes straight to your clipboard, so you can simply Ctrl+V it into your LLM prompt without any extra steps.
It respects git (skips .git and files matched by .gitignore) and excludes package manager lock files by default.
Usage
Run vibe -c path/to/codedir/you/wanna/discuss/with/AI and the full structured description of all files and folders will be ready in your clipboard;)
Or drop -c to print it to stdout, e.g. vibe src > context.md.
The help reference:
$ vibe --help
Usage: vibe [OPTIONS] [path]
Generate structured LLM context from a directory or file.
By default, prints to stdout, respects git and excludes package manager lock files.
GLOB without '/' matches names at any depth; with '/' it matches paths relative to the target; '**' spans
dirs.
╭─ Arguments ──────────────────────────────────────────────────────────────────────────────────────────────╮
│ path <path> Directory or file to build the context from. [default: .] │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --copy -c Copy the context to the clipboard instead of printing it. │
│ --summary-only -s Output only the summary, without file contents. │
│ --git -g --no-git -G Respect git: skip the .git directory and files matched by │
│ .gitignore. │
│ [default: git] │
│ --binary -b --no-binary -B List binary (non-text) files in the summary. │
│ [default: binary] │
│ --locks -l --no-locks -L Include package manager lock files. [default: no-locks] │
│ --include -i GLOB Only include files matching GLOB or inside matching │
│ directories, e.g. '*.py', 'src'. Repeatable. │
│ --exclude -x GLOB Skip files and directories matching GLOB, e.g. 'tests', │
│ '*.svg', 'docs/*.md'. Repeatable. │
│ --max-file-size -m SIZE Omit contents of text files larger than SIZE, e.g. 500KB. │
│ [default: 5MB] │
│ --version -V Show version and exit. │
│ --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 (only needed for -c/--copy to access your clipboard) install a support lib according 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. |
Metadata
Release files for show-me-your-vibe 0.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| show_me_your_vibe-0.2.0.tar.gz | 13.3 kB | Without provenance | Details for show_me_your_vibe-0.2.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| show_me_your_vibe-0.2.0-py3-none-any.whl | Python 3 | none | any | Details for show_me_your_vibe-0.2.0-py3-none-any.whl |
Total release size: 27.1 kB
Release files / show_me_your_vibe-0.2.0.tar.gz
| Download URL | show_me_your_vibe-0.2.0.tar.gz |
|---|---|
| Size | 13.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f30008addd6d9a3250e20e66e3ab28e2c8c9e235e640def5807b1e0b98d61f8d
|
|
BLAKE2b-256 checksum How to use checksums |
0636e4948b423de50e1d13df57733eca0223eef84fe705c183b66f0e5e4548ed
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.1.4 CPython/3.12.3 Linux/7.0.0-38-generic
|
Release files / show_me_your_vibe-0.2.0-py3-none-any.whl
| Download URL | show_me_your_vibe-0.2.0-py3-none-any.whl |
|---|---|
| Size | 13.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
7be66b615fcb94273e3c710c75f58ecc3b0b0ea074405387e1a0ced3a8439c9c
|
|
BLAKE2b-256 checksum How to use checksums |
940f3b6e49c72ed66f4624e3bad73de342c732cdc7eca31b205da23d0adf2582
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.1.4 CPython/3.12.3 Linux/7.0.0-38-generic
|
Security for show-me-your-vibe 0.2.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.
To learn more about protecting yourself from malicious actors, visit our package security documentation.