Skip to content

Getting Started

Choose your preferred installation method:

Terminal window
go install github.com/1broseidon/promptext/cmd/promptext@latest

Linux/macOS:

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

Windows PowerShell:

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

Download binaries from GitHub Releases and add to your PATH.

Terminal window
# Process current directory
promptext
# Process specific directory
promptext -d /path/to/project
# Show project overview only
promptext -info
# Export to file
promptext -o output.md
FlagDescription
-dDirectory to process
-eFile extensions (.go,.js)
-xExclude patterns
-fFormat (markdown, xml)
-oOutput file
-iInfo mode only
-vVerbose output

Filter by file type:

Terminal window
promptext -e .go,.js,.ts

Exclude directories:

Terminal window
promptext -x "node_modules/,vendor/,test/"

Generate XML report:

Terminal window
promptext -f xml -o report.xml

Continue with Configuration to customize behavior.