https://github.com/aseure/tracemod

🔬 Visually trace dependencies of your Go projects
https://github.com/aseure/tracemod

dependencies dependency dependency-graph go golang mermaid mermaidjs module modules

Last synced: 22 days ago
JSON representation

🔬 Visually trace dependencies of your Go projects

• Host: GitHub
• URL: https://github.com/aseure/tracemod
• Owner: aseure
• License: mit
• Created: 2023-12-21T14:09:32.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-01-12T17:06:13.000Z (12 months ago)
• Last Synced: 2024-10-28T20:49:32.429Z (2 months ago)
• Topics: dependencies, dependency, dependency-graph, go, golang, mermaid, mermaidjs, module, modules
• Language: Go
• Homepage: https://github.com/aseure/tracemod
• Size: 2.55 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        


    

        

        Generated by DALL-E

    



------

**tracemod** is a self-contained binary which lets you trace dependencies from

Go projects visually.

### 💻 Usage

Generate and display an SVG rendering of all the direct and transitive

dependencies matching `github.com/spf13/cobra`.

```shell

tracemod github.com/spf13/cobra

```

![tracemod example 1](./static/readme_example_1.png)

### 📦 Installation

- From GitHub: `go install github.com/aseure/tracemod@latest`

### ✨ Features

#### ♾️  Limit the number of dependency paths

Use the `-m`/`--max-traces` option to limit the maximum number of dependency

paths to generate. This is useful when looking for a dependency included in

many places, such as Protobuf.

#### 🗺️  Choose the graph direction

By default, the direction of the graph is automatically computed to better

represent the dependency tree. However, it is possible to force the rendering

by using the `-d`/`--direction` option to select among the different display

styles:

- `TB` for ⬇️ top-to-bottom

- `BT` for ⬆️ bottom-to-top

- `LR` for ➡️ left-to-right

- `RL` for ⬅️ right-to-left

#### 💎  Look for fixed strings

The search query is by default interpreted as a regular expression. For

convenience, this can be changed by using the `-F`/`--fixed-strings` option

flag to instead look for exact matches.

#### ⏱️  Specify a timeout

When the dependency tree is too big, a timeout can be specified to limit the

execution time of the program, using the `-t`/`--timeout` option. Whenever the

timeout is hit, the resulting dependency graph is still displayed, but keep in

mind that it will only be partial.