Skip to content

Commit

Permalink
docs: 📝 update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
w2xi committed Jan 27, 2024
1 parent 9a33290 commit 50956cc
Showing 1 changed file with 44 additions and 12 deletions.
56 changes: 44 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,64 @@
# treei

`treei` 是一个命令函工具,用于生成目录结构的树。
`treei` is a node command line tool to generate directory structure tree

## 安装
## Installation

```bash
npm i treei -g
```

## 使用
## Usage

```bash
treei
$ treei -h
Usage: treei [options]

Generate a directory structure tree

Options:
-V, --version output the version number
-i, --ignore <ig> ignore specific directory name
-d, --depth <depth> specify the depth of output
-f, --only-folder output folder only
--icon output emoji icon, prefixing filename or directory
-o, --output <output> export content into a file
-h, --help display help for command
```

## 案例
## Examples

```bash
$ treei -i '.git,node_modules'
treei
├──.gitignore
├──package-lock.json
├──package.json
├──README.md
└──src
| └──index.js
```

输出:

```bash
$ treei -i '.git,node_modules' --icon
treei
├──📄.gitignore
├──📄package-lock.json
├──📄package.json
├──📄README.md
└──📁src
| └──📄index.js
```

```bash
$ treei -i '.git,node_modules' -o result.md
treei
├── .gitignore
├── package.json
├── README.md
└── src
| └── index.js
├──.gitignore
├──package-lock.json
├──package.json
├──README.md
└──src
| └──index.js

# The output has been saved into ./result.md
```

0 comments on commit 50956cc

Please sign in to comment.