asciifolders

                    _ _ ______    _     _
     /\            (_|_)  ____|  | |   | |
    /  \   ___  ___ _ _| |__ ___ | | __| | ___ _ __ ___
   / /\ \ / __|/ __| | |  __/ _ \| |/ _` |/ _ \ '__/ __|
  / ____ \\__ \ (__| | | | | (_) | | (_| |  __/ |  \__ \
 /_/    \_\___/\___|_|_|_|  \___/|_|\__,_|\___|_|  |___/

Generate an ASCII directory tree from any folder on your machine

Prerequisites

[!Note] AsciiFolders requires Node 20.9.0 or later.

Usage

Using npm

npx asciifolders

Using pnpx

pnpx asciifolders

Using bunx

bunx asciifolders

Contributions

If you're a contributor you'd want to run the app locally on your machine to test your code, to do that make sure to:

1. Clone the repo
2. cd into the repo
3. Add your modifications
4. Run npm run build to build the package
5. Run npm link -g to link the package to your global packages list
6. Run asciifolders from anywhere to test

Documentation

Check the documentation to get you started!

Author

Eihab Khan

• Porfolio: eihabkhan.com
• GitHub: github/eihabkhan
• X: x/itseihab

License

Copyright © 2025, Eihab Khan. Released under the MIT License.