Skip to content

A fast terminal-based file inspector with live preview, fuzzy search, and multi-language support. Built for developers who need rapid code browsing.

License

Notifications You must be signed in to change notification settings

Cod-e-Codes/parsec

Repository files navigation

Parsec: Terminal-Based File Summarizer TUI

Parsec is a fast, terminal-based file inspector that provides immediate summaries of source code files. Built for developers who need rapid context-aware code browsing.

Screenshot

Parsec TUI Interface

Parsec's split-screen interface showing file navigation and executable help display

Features

  • Split-screen interface with file tree and detailed summary view
  • Directory navigation with live content preview
  • Real-time fuzzy search capabilities
  • Multi-language support: Go, Python, JavaScript, TypeScript, Rust, Java, C/C++
  • Enhanced file parsing:
    • Markdown rendering with syntax highlighting
    • Configuration file parsing (JSON, YAML, INI, ENV)
    • Text file preview with line counts
    • Executable help text extraction
  • Intelligent parsing of functions, imports, types, and structs
  • Responsive design with terminal resize handling
  • Keyboard-driven interface with vim-style bindings
  • Asynchronous operations for smooth performance

Installation

git clone https://github.com/Cod-e-Codes/parsec.git
cd parsec
go build .

Usage

# Scan current directory
./parsec

# Scan specific directory
./parsec /path/to/project

# Windows paths
./parsec "C:\Users\username\Projects"

# Unix paths
./parsec /home/user/code

# Show help
./parsec -h

Keyboard Controls

Key Action
↑/↓ or k/j Navigate file list
Enter Enter directory or open file
/ Start fuzzy search
PgUp/PgDn Scroll summary content
Home/End Jump to first/last file
t Toggle directory visibility
r Refresh current directory
q or Ctrl+C Quit

Supported File Types

Category Extensions Features
Programming .go .py .js .ts .rs .java .c .cpp Functions, types, imports
Documentation .md .markdown .rst Headers, links, rendered content
Configuration .json .yaml .ini .env Keys, structure
Data .xml .csv .log Content preview
Executables .exe .bin Help text extraction

Project Structure

parsec/
├── main.go             # Application entrypoint
├── ui/                 # Interface components
├── core/               # Analysis engine
├── utils/              # Utilities
└── docs/              # Documentation

Contributing

Parsec welcomes contributions from the community. Please review our contribution guidelines before getting started:

Development Process

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Test thoroughly
  5. Submit a pull request

Reporting Issues

When reporting bugs, please include:

  • Operating system details
  • Steps to reproduce
  • Expected vs actual behavior
  • Error messages if applicable

Security

For security concerns, please review our Security Policy before submitting a report.

Dependencies

Dependencies are managed through Go modules and automatically updated via Dependabot. Major version updates are handled manually to ensure stability.

License

MIT License - see LICENSE file for details.

Versioning

Parsec follows semantic versioning. The first stable release will be tagged as v1.0.0 once all core features are thoroughly tested.

About

A fast terminal-based file inspector with live preview, fuzzy search, and multi-language support. Built for developers who need rapid code browsing.

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

No packages published

Languages