Thanks to visit codestin.com
Credit goes to github.com

Skip to content

ro-mish/vrep

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

vrep

Screenshot 2025-01-03 at 5 36 54 PM

vrep is a tool for visualizing codebase repositories. It provides a graphical representation of the repository's structure, making it easier to understand the relationships between different project parts.

Getting started

4 steps for easy setup.

First clone the repo.

git clone https://github.com/ro-mish/vrep.git

Next, change into the vrep repo.

cd vrep

To install vrep, you can use make install:

make install

This will install vrep and its dependencies.

Next, initialize the virtual environment:

source venv/bin/activate

You're ready to visualize some repo's!

Usage

To use vrep cli, you can use:

vrep path/to/your/repo

If you want to use it for your current repo, navigate to the root directory of the Git repository you want to visualize and run the following command:

vrep .

This will launch a web browser with an interactive visualization of the repository's commit history.

Customizing the Visualization

You can customize the visualization by creating a configuration file. The configuration file should be in YAML format and can be placed anywhere in the repository. To use a custom configuration file, specify its path when running vrep:

vrep --config path/to/config.yaml

About

Quick viz for grokking your repo.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published