Skip to content

CLI tool to analyze directory structures and source files for reviews, audits, and automation.

License

Notifications You must be signed in to change notification settings

marllondevsec/SeeF

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SeeF Menu

SeeF

SeeF is a CLI tool designed to analyze directory structures and file contents in an organized way, focused on facilitating technical reviews, audits, and analysis.

It automatically generates:

  • The project directory tree
  • A list of relevant files
  • The full content of files within configurable limits

🚀 Features

  • 📁 Displays complete directory structure
  • 📄 Reads and outputs code file contents
  • 🎯 Filters by maximum file size
  • 🧩 Includes only specific file extensions
  • 🚫 Excludes unwanted directories
  • 📋 Copies output to clipboard
  • 💾 Exports analysis to a file
  • 🌍 Multi-language support (EN/PT)
  • 🎨 Colored output with optional disable

📦 Installation

Quick method

make install

Manual

chmod +x install.sh
./install.sh

The installer:

  • Detects the operating system
  • Checks dependencies
  • Configures language
  • Installs to ~/.local/bin

🧪 Quick Test

seef --help
seef ./my-project

🛠️ Usage

Basic usage

seef ./my_project

With size limit

seef -s 5 ./project  # 5MB limit

Tree only

seef -t ./project

With custom extensions

seef -e ".csv,.xml,.txt" ./project

Excluding additional directories

seef -x "test,coverage" ./project

Save output to file

seef -o analysis.txt ./project

Copy to clipboard

seef -c ./project

Without colors

seef --no-color ./project

Set language

seef --lang en ./project
seef --lang pt ./projeto

📁 Project Structure

SeeF
├── bin
│   └── seef
├── build
├── install.sh
├── uninstall.sh
├── Makefile
├── README.md
└── src
    └── locales
        ├── en.sh
        └── pt.sh

⚙️ Configuration

After installation, the configuration file is located at:

~/.config/seef/seef.conf

Available parameters:

  • MAX_FILE_SIZE
  • EXCLUDE_DIRS
  • USE_COLOR
  • DEFAULT_LANG
  • CLIPBOARD_TOOL

🗑️ Uninstall

make uninstall

Or directly:

./uninstall.sh

📄 License

This project is open-source and may be freely used for personal or professional purposes.


🤝 Contributing

Contributions are welcome! Suggestions, improvements, and pull requests help make SeeF even better.

About

CLI tool to analyze directory structures and source files for reviews, audits, and automation.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published