https://github.com/elbachir-one/gt

gt is a tree-like program written in Go with a lot of features.
https://github.com/elbachir-one/gt

Last synced: about 2 months ago
JSON representation

gt is a tree-like program written in Go with a lot of features.

• Host: GitHub
• URL: https://github.com/elbachir-one/gt
• Owner: elbachir-one
• License: bsd-3-clause
• Created: 2024-07-15T15:55:45.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2024-07-28T18:13:07.000Z (about 2 months ago)
• Last Synced: 2024-07-29T10:27:34.909Z (about 2 months ago)
• Language: Go
• Size: 164 KB
• Stars: 37
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# gt

`gt`, is a command-line tool written in Go that displays a tree of files

and directories with colored icons.

![gt shot](https://i.postimg.cc/7ZWY5KDJ/gt.png)

## Features

- Displays a tree of files and directories.

- Supports showing hidden files.

- Option to unsort files.

- Displays summary of files and directories.

- Colored icons based on file types.

- List directories.

- Order files.

- Print full path.

## Installation

1. Ensure you have [Go](https://go.dev/dl/) installed, and also [Nerd Fonts](https://www.nerdfonts.com)

2. Clone the repository

```bash

   git clone https://github.com/elbachir-one/gt

   cd gt/

   go build

   ./gt

```

3. Install

```bash

    sudo cp gt /usr/local/bin/gt

    gt

```

#### Note: gt is in the [AUR](https://aur.archlinux.org/packages/gt), and a [template](https://github.com/elbachir-one/void-templates) is available for Void Linux.

- Arch Linux

```bash

    yay -S gt

```

- Void Linux

```bash

    git clone --depth=1 https://github.com/void-linux/packages

    cd void-packages/

    ./xbps-src binary-bootstrap

    mkdir srcpkgs/gt

    vim srcpkgs/gt/template

```

Past the content of this

[template](https://github.com/elbachir-one/void-templates) to your local

template and save it.

```bash

    ./xbps-src pkg gt

    sudo xbps-install -R hostdir/binpkgs gt

```

## Usage

```bash

    gt [OPTIONS] [DIRECTORY]

```

#### Note: you can also pip `gt` to `fzf` or `less`.

```bash

    gt | less -r

```

![gt and less](https://i.postimg.cc/d3tzmKjs/2024-07-21-18-05.png)

`-r` is an option for less to repaint the screen.

```bash

    gt | fzf --ansi

```

![gt and fzf](https://i.postimg.cc/C5P9c6cj/2024-07-21-18-06.png)

Options:

| Option  | Description                                                                                                                    | example                                          |

|---------|--------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------|

| -h      | Show help                                                                                                                      | ![-h](https://i.postimg.cc/647QG2YT/h.png)       |

| -v      | Show version                                                                                                                   | ![-v](https://i.postimg.cc/xk0T3Ftw/v.png)       |

| -s      | Show hidden files                                                                                                              | ![-s](https://i.postimg.cc/4YR3m3tN/s.png)       |

| -u      | Files                                                                                                                          | ![-u](https://i.postimg.cc/Bj5nDGc5/u.png)       |

| -m      | Summary                                                                                                                        | ![-m](https://i.postimg.cc/PNcJny5D/m.png)       |

| -d      | List directories only                                                                                                          | ![-d](https://i.postimg.cc/YGD99fNJ/d.png)       |

| -o      | Order files based on extension                                                                                                 | ![-o](https://i.postimg.cc/VdC6ftJV/o.png)       |

| -f      | Print full path prefix to each file                                                                                            | ![-f](https://i.postimg.cc/mhhknJBR/f.png)       |

| --depth | Depth to which the tree should be displaye the default is -1 `gt --depth 1` any number greater than or equal to 1 can be used. | ![--depth](https://i.postimg.cc/yg8xsrRm/dd.png) |

## Contributing

Contributions, issues, and feature requests are always welcome! Thank you.