Skip to content

aina-deji/OpenText

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

FLtxt

Convert any project folder into a single, clean text file — instantly and privately.

Website npm Version npm Downloads Node.js License GitHub Stars PRs Welcome

FLtxt is a serverless, privacy-first tool that turns an entire project folder into a single consolidated .txt file. It generates a project tree, merges supported text files, and automatically ignores unnecessary folders like node_modules and .git.

Perfect for AI assistants, code reviews, documentation, and project sharing.


📚 Table of Contents


🚀 Why FLtxt?

Sharing a project with an AI or another developer often means sending dozens or hundreds of files.

FLtxt packages everything into one clean, readable .txt document while preserving the project structure and filtering out unnecessary files. Everything runs locally, so your code never leaves your computer.


✨ Features

  • 📁 Smart filtering
  • 🌳 ASCII directory tree
  • 🧩 Granular file selection (Web)
  • 🚀 100% local processing
  • 🖥️ CLI support
  • 📦 Zero dependencies

🌐 Web App

Visit https://fltxt.netlify.app

  1. Drag & drop a project folder.
  2. Review detected files.
  3. Uncheck anything you don't need.
  4. Click Generate & Download TXT.

🖥️ CLI

Installation

npm install -g fltxt-cli

Usage

fltxt [directory] [--output filename.txt]

Options

Option Description
directory Folder to process (defaults to current directory).
-o, --output Custom output filename.

Examples

fltxt
fltxt ~/my-awesome-project
fltxt ~/my-project -o my-project.txt

📄 Example Output

--- TREE STRUCTURE ---
my-project
|-- src
|   |-- index.js
|   `-- utils.js
`-- README.md

--- START OF FILE: src/index.js ---
...
--- END OF FILE ---

🛠️ Development

Clone the repository:

git clone https://github.com/aina-deji/OpenText.git
cd OpenText

Run locally:

node cli.js [directory]

Optional alias:

echo 'alias fltxt="node '$(pwd)'/cli.js"' >> ~/.bashrc
source ~/.bashrc

📂 Project Structure

.
├── assets/
├── css/
├── js/
│   ├── processor.js
│   └── ui.js
├── cli.js
├── index.html
├── manifest.json
├── serviceWorker.js
├── package.json
├── LICENSE
└── README.md

🧪 Testing

node cli.js ~/my-test-folder

🤝 Contributing

Contributions are welcome!

  • 🐛 Bug reports
  • ✨ Feature requests
  • 🔧 Code improvements
  • 📖 Documentation

Please open an issue or submit a pull request.


❓ FAQ

Do I need Node.js?

Yes. Node.js v14 or later is required for the CLI.

Does FLtxt upload my files?

No. Everything runs locally.

What file types are supported?

Most text-based formats including .js, .ts, .html, .css, .json, .md, .py, .java, .go, .rs, .sh, .env, and more.

Update

npm update -g fltxt-cli

📌 Version History

See the Releases page: releases


📄 License

MIT © Aina Ayodeji


❤️ Acknowledgments

Built with Vanilla JavaScript, Tailwind CSS, and a little terminal magic.


🔗 Links


⭐ Support

If FLtxt helped you:

  • ⭐ Star the repository
  • 🐞 Report issues
  • 🤝 Contribute
  • 📢 Share it

About

Fltxt is a serverless tool that covert a code project folder into a single txt file

Topics

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages