gct

KO | EN

gitlite — search

#javascript #react #typescript #android #rust #deep-learning #docker #macos #nodejs #awesome #security #mcp #ios #open-source

(★ 54)

Graphical Code Tracer (GCT): Visualize code at lightning speed

gct Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Graphical Code Tracer
<p align="center">
  <a href="https://pepy.tech/project/gct-py">
    <img src="https://static.pepy.tech/badge/gct-py" alt="users">
  </a>
  <a href="https://github.com/QasimWani/gct/blob/main/LICENSE">
    <img src="https://img.shields.io/badge/License-GNU%20GPL-green.svg" alt="license"/>
  </a>
  <a href="https://pypi.org/project/gct-py">
    <img src="https://img.shields.io/pypi/v/gct-py?color=blue" alt="license"/>
  </a>
  <a href="https://github.com/QasimWani/gct/graphs/contributors" alt="Contributors">
    <img src="https://img.shields.io/github/contributors/QasimWani/gct" />
  </a>
  <a target="_blank" href="https://twitter.com/intent/tweet?text=GCT is a code visualization tool that generates a graphical representation of any python program! Try it out: https://gctpy.com" class="item">
          <img src="https://img.shields.io/twitter/url?label=Tweet&amp;style=social&amp;url=https://gctpy.com">
        </a>
</p>

Graphical Code Tracer (gct) is the world's first visual static code analyzer.

Within **seconds** it can tell you how your functions and classes are connected to each other!

![](https://raw.githubusercontent.com/QasimWani/gct/main/demo.gif)

[Getting started](#getting-started) •
[Installation](#installation) •
[Configuration](#configuration)

</div>

## Getting started

### Usecases:
1. Onboard to new codebases faster.
2. Debug code faster [Twitter thread](https://twitter.com/qasim31wani/status/1609677492347981825)
3. Create share-able versions of your code. Using gctpy.com, you can instantly share your UML diagrams across teams.

Generate graph for any python file
```sh
python -m gct -i path/to/file.py # run gct on a local file
python -m gct -i https://github.com/user_name/path/to/file.py # run gct on a file hosted on a web server
```

## Installation

### *Step 1: Install GCT Python package*

```
pip install gct-py
```

### *Step 2: Install Graphviz executable*

GCT generates graphs using [graphviz](https://graphviz.org). To get accurate graphs, we highly
recommend using latest graphviz version available for your OS.

**Skip this step** if you've already installed graphviz executable version. Check the dot version by running: `dot -V`.

<details>
  <summary>Windows</summary>

Install graphviz by downloading executable (version >=6.0.1) from [graphviz](https://graphviz.org/download/#windows) website.
  
</details>

<details>
  <summary>MacOS</summary>

(Optional) more details: [graphviz](https://graphviz.org/download/#mac).
  
```
  brew install graphviz
```
  
</details>

<details>
  <summary>Linux</summary>

(optional) more details: [graphviz](https://graphviz.org/download/#linux).
  
```
  sudo apt install graphviz
```
  
</details>
  
  
## Configuration

Customize the experience by aliasing `gct`:
```
alias gct='python -m gct -i'
gct path/to/file.py
```

gct

gct Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

gct

gct Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README