Getting Started
Installation
Section titled “Installation”Choose your preferred installation method:
Go Install (Recommended)
Section titled “Go Install (Recommended)”go install github.com/1broseidon/promptext/cmd/promptext@latest
Script Install
Section titled “Script Install”Linux/macOS:
curl -sSL https://raw.githubusercontent.com/1broseidon/promptext/main/scripts/install.sh | bash
Windows PowerShell:
irm https://raw.githubusercontent.com/1broseidon/promptext/main/scripts/install.ps1 | iex
Manual Install
Section titled “Manual Install”Download binaries from GitHub Releases and add to your PATH.
Basic Usage
Section titled “Basic Usage”Simple Commands
Section titled “Simple Commands”# Process current directorypromptext
# Process specific directorypromptext -d /path/to/project
# Show project overview onlypromptext -info
# Export to filepromptext -o output.md
Common Options
Section titled “Common Options”Flag | Description |
---|---|
-d | Directory to process |
-e | File extensions (.go,.js ) |
-x | Exclude patterns |
-f | Format (markdown , xml ) |
-o | Output file |
-i | Info mode only |
-v | Verbose output |
Examples
Section titled “Examples”Filter by file type:
promptext -e .go,.js,.ts
Exclude directories:
promptext -x "node_modules/,vendor/,test/"
Generate XML report:
promptext -f xml -o report.xml
Continue with Configuration to customize behavior.