Skip to main content

Getting Started

Installation​

Prerequisites​

All Platforms​

  • Git (for version control features)

Platform-Specific​

  • Linux/macOS: No additional requirements
  • Windows:
    • PowerShell 5.1 or higher
  • Go Installation: Go 1.22 or higher (if installing via go install)

Installation Methods​

  1. Quick Install:

Linux/macOS:

Install:

curl -sSL https://raw.githubusercontent.com/1broseidon/promptext/main/scripts/install.sh | bash

Additional options:

curl -sSL https://raw.githubusercontent.com/1broseidon/promptext/main/scripts/install.sh | bash -h

The Linux/macOS installer provides:

  • 🏠 User-level installation in ~/.local/bin
  • 🔒 Automatic checksum verification
  • 📁 Custom installation directory support
  • ⚡ PATH environment configuration
  • 💫 Shell alias configuration
  • 🔄 Clean uninstallation

Windows (PowerShell):

Install:

irm https://raw.githubusercontent.com/1broseidon/promptext/main/scripts/install.ps1 | iex

Uninstall:

irm https://raw.githubusercontent.com/1broseidon/promptext/main/scripts/install.ps1 | iex -Uninstall

Both installers provide:

  • 🏠 User-level installation (in ~/.local/bin or %LOCALAPPDATA%)
  • 🔒 Automatic checksum verification
  • 📁 Custom installation directory support
  • ⚡ PATH environment configuration
  • 💫 Shell/PowerShell alias creation (prx)
  • 🔄 Clean uninstallation
  1. Using Go Install:
go install github.com/1broseidon/promptext/cmd/promptext@latest
  1. Manual Installation:

Download the appropriate binary for your platform from the releases page:

Linux/macOS:

  • Download the appropriate binary
  • Make it executable: chmod +x promptext
  • Create directory: mkdir -p ~/.local/bin
  • Move to PATH: mv promptext ~/.local/bin/

Windows:

  • Download the Windows binary (ZIP file)
  • Extract to a directory (e.g., %LOCALAPPDATA%\promptext)
  • Add the directory to your PATH:
    • System Settings > Advanced > Environment Variables
    • Edit the User PATH variable
    • Add the installation directory

Usage​

Basic Command Structure​

promptext [flags]

Available Flags​

  • -version, -v: Show version information
  • -directory, -d string: Directory to process (default ".")
  • -extension, -e string: File extensions to include (comma-separated, e.g., ".go,.js")
  • -exclude, -x string: Patterns to exclude (comma-separated)
  • -format, -f string: Output format (markdown/xml)
  • -output, -o string: Output file path
  • -info, -i: Show only project summary with token counts
  • -verbose, -V: Show full file contents
  • -debug, -D: Enable debug logging
  • -gitignore, -g: Use .gitignore patterns (default true)
  • -use-default-rules, -u: Use default filtering rules (default true)
  • -help, -h: Show help message

Examples​

  1. Process specific file types:
promptext -extension .go,.js
  1. Export as XML with debug info:
promptext -format xml -output project.xml -debug
  1. Show project overview with token counts:
promptext -info
  1. Process with exclusions:
promptext -exclude "test/,vendor/" -V
  1. Check version:
promptext -v  # Show version information
promptext --version  # Same as above

# Example output:
# promptext version v0.2.4 (2024-12-19)
  1. Process all files including dependencies:
promptext -u=false -exclude "test/" # Disable default rules but keep test/ excluded