dtree-deno

A simple CLI for generate the dir tree with deno.

✅ Windows
✅ MacOS

Install

Using the following commands.

deno install --allow-all --unstable -n dtree https://deno.land/x/deno_tree/src/index.ts

Done, try the following command in terminal.

dtree

Install from git

This methos is for non-denoLand install. If you are using the top method to install, you can skip this sections.

Git clone the project first

git clone https://github.com/r48n34/dtree-deno.git

Install with deno task

deno task install

Run with dtree

dtree

Result

Using this repo for samples, the cli will output this result.

dtree

PS D:\github-repo\dtree > dtree
📂 .
├── deno.json
├── deno.lock
├── README.md
└─┬ 📂 src
  ├── dir-tree-creator.ts
  └── index.ts

Success to copy to your clipboard.

Config (All are Optional flags)

Name	Params	Type	Description
Shows Hidden folder	`--hidden`, `-h`	boolean	Will include the ‘.’ folder output this result.
No auto copy result	`--noCopy`, `-n`	boolean	Will not auto copy the result.
Set max depth tree	`--maxDepth`, `-m`	number	Set the max depth generate to the tree
Set No Icon display	`--noIcon`	boolean	Set the tree display without the icon `📂`
Set Icon display	`--icon`	string	Set the tree display icon (Default: `📂`)

More demo usgae

`--hidden`

The --hidden or -h flag will include the ‘.’ folder output this result.

dtree --hidden

PS D:\github-repo\dtree > dtree --hidden
📂 .
├─┬ 📂 .git
│ └── ...
├── .gitignore
├─┬ 📂 .vscode
│ └── ...
├── deno.json
├── deno.lock
├── README.md
└─┬ 📂 src
  ├── dir-tree-creator.ts
  └── index.ts

Success to copy to your clipboard.

`--noCopy`

The --noCopy or -n flag will not auto copy the result.

dtree --noCopy

PS D:\github-repo\dtree > dtree --noCopy
📂 .
├── deno.json
├── deno.lock
├── README.md
└─┬ 📂 src
  ├── dir-tree-creator.ts
  └── index.ts

`--maxDepth`

The --maxDepth or -m flag can set the max depth generate to the tree.
Default: Infinity

dtree --maxDepth <number>

# Set a max depth to 1
PS D:\github-repo\dtree> dtree -m 1
📂 .
├── deno.json
├── deno.lock
├── README.md
└── 📂 src

Success to copy to your clipboard.

`--noIcon`

The --noIcon flag can the tree display without the icon 📂.

dtree --noIcon

PS D:\github-repo\dtree> dtree --noIcon
.
├── deno.json
├── deno.lock
├── README.md
└─┬ src
  ├── archy.ts
  ├── dir-tree-creator.ts
  ├── help.ts
  ├── index.ts
  └─┬ interface
    └── interface.ts

Success to copy to your clipboard.

`--icon`

The --icon flag can the tree display icon to your icons.
Default: 📂

dtree --icon <string>

PS D:\github-repo\dtree> dtree --icon 📦
📦 .
├── deno.json
├── deno.lock
├── README.md
└─┬ 📦 src
  ├── archy.ts
  ├── dir-tree-creator.ts
  ├── help.ts
  ├── index.ts
  └─┬ 📦 interface
    └── interface.ts

Success to copy to your clipboard.

Notices

The script will default to ignore all __pycache__ and node_modules related files. Unless you are using the command inside either one of the folder.

Uninstall

deno uninstall dtree