https://github.com/bayashi/goverview

`goverview` provides an overview as ASCII tree for a Golang project
https://github.com/bayashi/goverview

go golang tool treeview

Last synced: 4 months ago
JSON representation

`goverview` provides an overview as ASCII tree for a Golang project

• Host: GitHub
• URL: https://github.com/bayashi/goverview
• Owner: bayashi
• License: mit
• Created: 2023-04-11T22:25:21.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-12-31T06:35:59.000Z (over 1 year ago)
• Last Synced: 2025-07-17T11:03:05.919Z (11 months ago)
• Topics: go, golang, tool, treeview
• Language: Go
• Homepage:
• Size: 39.1 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# goverview







`goverview` provides an overview as ASCII tree for a Golang project.

## Usage

    $ goverview ~/go/src/github.com/bayashi/goverview

    

    ┌ goverview/

    ├─┬ .github/

    │ └─┬ workflows/

    │   └── run-tests.yaml

    ├── .gitignore

    ├── LICENSE: License MIT

    ├── README.md

    ├──* arg.go: main

    ├──* builder.go: main

    ├──* cmd.go: main

    ├─┬ fileinfo/

    │ ├──* fileinfo.go: fileinfo

    │ │     Struct: FileInfo

    │ ├──* go.go: fileinfo

    │ │     Func: GoInfo

    │ ├──* gomod.go: fileinfo

    │ │     Func: GoModInfo

    │ └──* license.go: fileinfo

    │       Func: LicenseInfo

    ├── go.mod: go 1.19

    ├── go.sum

    └──* main.go: main

You can see also private stuff with `-a` option.

    $ goverview ~/go/src/github.com/bayashi/goverview -a

    

    ┌ goverview/

    ├─┬ .github/

    │ └─┬ workflows/

    │   └── run-tests.yaml

    ├── .gitignore

    ├── LICENSE: License MIT

    ├── README.md

    ├──* arg.go: main

    │     struct: options

    │     func: parseArgs

    ├──* builder.go: main

    │     struct: walkerArgs

    │     func: fromLocal, validateDirPath, buildTree, isSkipPath, walkProcess, getFileInfo

    ├──* cmd.go: main

    │     func: putErr, putUsage, putHelp

    ├─┬ fileinfo/

    │ ├──* fileinfo.go: fileinfo

    │ │     Struct: FileInfo

    │ ├──* go.go: fileinfo

    │ │     struct: organizer

    │ │     Func: GoInfo

    │ │     func: goInfoProcessIdent, buildDescriptions

    │ ├──* gomod.go: fileinfo

    │ │     Func: GoModInfo

    │ └──* license.go: fileinfo

    │       Func: LicenseInfo

    ├── go.mod: go 1.19

    ├── go.sum

    └──* main.go: main

          func: main, run

Full options:

    Usage: goverview [OPTIONS] DIR

    Options:

      -h, --help                 Show help (This message) and exit

      -t, --hide-test            Hide contents of test files

          --ignore stringArray   Ignore path to show if a given string would match

      -a, --show-all             Show all stuff

      -v, --version              Show version and build info and exit

## Installation

    go install github.com/bayashi/goverview@latest

## License

MIT License

## Author

Dai Okabayashi: https://github.com/bayashi