A command-line tool that formats tree command output with aligned or decorated comments, making directory structure documentation more readable
A command-line tool to format tree command output with aligned comments.
npm install -g tree-noter
tree-noter [file] [options]
input.txt:
.
├── bin # Executable scripts
│ └── www # App entry point and server setup
├── public # Static assets
│ ├── images # Image files
│ ├── javascripts # Frontend JS
│ └── stylesheets # CSS files
│ └── style.css # Default stylesheet
├── routes # Route definitions
│ ├── index.js # Root path handler
│ └── users.js # /users route handler
├── views # Pug templates
│ ├── error.pug # Error page template
│ ├── index.pug # Home page template
│ └── layout.pug # Base layout template
├── app.js # App config and route setup
└── package.json # Project metadata and dependencies
$ tree-noter input.txt
.
├── bin Executable scripts
│ └── www App entry point and server setup
├── public Static assets
│ ├── images Image files
│ ├── javascripts Frontend JS
│ └── stylesheets CSS files
│ └── style.css Default stylesheet
├── routes Route definitions
│ ├── index.js Root path handler
│ └── users.js /users route handler
├── views Pug templates
│ ├── error.pug Error page template
│ ├── index.pug Home page template
│ └── layout.pug Base layout template
├── app.js App config and route setup
└── package.json Project metadata and dependencies
$ tree-noter -d input.txt
.
├── bin ---------------------------------------------- Executable scripts
│ └── www ---------------------------- App entry point and server setup
├── public ------------------------------------------------ Static assets
│ ├── images ---------------------------------------------- Image files
│ ├── javascripts ----------------------------------------- Frontend JS
│ └── stylesheets ------------------------------------------- CSS files
│ └── style.css -------------------------------- Default stylesheet
├── routes -------------------------------------------- Route definitions
│ ├── index.js -------------------------------------- Root path handler
│ └── users.js ----------------------------------- /users route handler
├── views ------------------------------------------------- Pug templates
│ ├── error.pug ----------------------------------- Error page template
│ ├── index.pug ------------------------------------ Home page template
│ └── layout.pug --------------------------------- Base layout template
├── app.js ----------------------------------- App config and route setup
└── package.json ---------------------- Project metadata and dependencies
$ tree-noter -d -s '👻'
.
├── bin 👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻 Executable scripts
│ └── www 👻👻👻👻👻👻👻👻👻👻👻👻👻👻 App entry point and server setup
├── public 👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻 Static assets
│ ├── images 👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻 Image files
│ ├── javascripts 👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻� Frontend JS
│ └── stylesheets 👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻� CSS files
│ └── style.css 👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻 Default stylesheet
├── routes 👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻 Route definitions
│ ├── index.js 👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻 Root path handler
│ └── users.js 👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻� /users route handler
├── views 👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻� Pug templates
│ ├── error.pug 👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻� Error page template
│ ├── index.pug 👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻 Home page template
│ └── layout.pug 👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻� Base layout template
├── app.js 👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻👻� App config and route setup
└── package.json 👻👻👻👻👻👻👻👻👻👻👻 Project metadata and dependencies
-o, --output <file>: Output file (uses stdout if not specified)-d, --decorator [separator]: Use decorator style with optional separator (default: -----)-g, --gap <width>: Gap between tree and comments (default: 30)-c, --comment-marker <marker>: Comment marker to look for (default: #)-w, --wrap: Enable comment wrapping for long comments-m, --max-width <width>: Maximum width for output (auto-detects terminal width if not specified)-i, --indent <spaces>: Spaces to indent wrapped comment lines (default: 2)FAQs
A command-line tool that formats tree command output with aligned or decorated comments, making directory structure documentation more readable
We found that tree-noter demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Multiple high-impact npm maintainers confirm they have been targeted in the same social engineering campaign that compromised Axios.
Security News
Axios compromise traced to social engineering, showing how attacks on maintainers can bypass controls and expose the broader software supply chain.
Security News
Node.js has paused its bug bounty program after funding ended, removing payouts for vulnerability reports but keeping its security process unchanged.