promptext

module
v0.2.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 18, 2024 License: MIT

README ΒΆ

promptext

πŸ“ Smart code context extractor for AI assistants

Go Report Card Release

promptext is an intelligent code context extraction tool designed specifically for AI assistant interactions. It analyzes your codebase, filters relevant files, estimates token usage, and provides formatted output suitable for AI prompts.

Key Features

  • πŸ” Smart file filtering with .gitignore support
  • πŸ“Š Automatic token counting for AI context limits
  • πŸ—‚οΈ Intelligent project structure analysis
  • πŸ“ Multiple output formats (Markdown, XML)
  • πŸ”§ Configurable via CLI flags or .promptext.yml
  • πŸ“ˆ Project statistics and metadata extraction

Quick Install

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

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

Basic Usage

# Process current directory
promptext

# Process specific file types
promptext -extension .go,.js

# Show project summary with token counts
promptext -info

# Export as XML with debug logging
promptext -format xml -output project.xml -debug

See our full documentation for:

  • Advanced configuration options
  • Output format details
  • File filtering rules
  • Project analysis features
  • Token counting methodology
  • And more!

License

MIT License - see LICENSE for details.

Directories ΒΆ

Path Synopsis
cmd
internal
log

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL