Getting Started

Installation

Choose your preferred installation method:

Go Install (Recommended)

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

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

Download binaries from GitHub Releases and add to your PATH.

Basic Usage

Simple Commands

# 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

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

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.