Documentation
Installation
macOS
Download the Universal DMG file for both Intel and Apple Silicon Macs.
Download macOS Universal DMGDouble-click the downloaded `.dmg` file and drag the GPTree application to your Applications folder.
Windows
Download either the `.exe` installer or the `.msi` package.
Run the downloaded installer and follow the on-screen instructions. Requires Windows 10 or later.
Linux
The easiest way to install on most Linux distributions is via the install script:
curl -fsSL https://gptree.dev/install.sh | sh
Alternatively, you can download the package format suitable for your distribution:
Quick Start
- Launch the GPTree application.
- Click the "Open Project" button or use the menu (File > Open Folder) to select your project directory.
- The file tree of your project will appear in the left panel.
- Click on files or folders in the tree to select them. Selected items will be highlighted.
- Selected files' content will be added to the right-hand preview panel, formatted with markers.
- Use the checkboxes in the settings panel (if available/implemented) to toggle options like respecting `.gitignore`.
- Once you've selected all desired files/folders, click the "Copy to Clipboard" button.
- Paste the generated context into your LLM prompt.
Configuration
GPTree aims for simplicity, but offers some configuration options (details may evolve):
- Respect `.gitignore` files: (Usually enabled by default) This option ensures that files and patterns listed in your project's `.gitignore` (and global gitignore) are excluded from selection and output.
- Include Hidden Files/Folders: Toggle whether items starting with a dot (`.`) are shown in the file tree and included in the output.
- Output Formatting: Potential future options might allow customizing the markers used in the combined output text.
Settings might be accessible via a dedicated settings panel within the app or through menu options.