https://github.com/sloganking/codevis

Turns your code into one large image
https://github.com/sloganking/codevis

highlighting image rust visualization

Last synced: about 4 hours ago
JSON representation

Turns your code into one large image

• Host: GitHub
• URL: https://github.com/sloganking/codevis
• Owner: sloganking
• License: mit
• Created: 2022-01-17T05:20:32.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2024-02-25T07:35:14.000Z (10 months ago)
• Last Synced: 2024-12-15T15:08:45.822Z (7 days ago)
• Topics: highlighting, image, rust, visualization
• Language: Rust
• Homepage:
• Size: 348 KB
• Stars: 223
• Watchers: 2
• Forks: 7
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# codevis

**codevis** takes all source code / UTF-8 encodable files in a folder and renders them to one image, syntax highlighting any file it knows how to. These images show the shape and size of files, but not the exact characters inside the files. 

## Notes

Looking for a video instead of an image? Check out this repo's sister project [codemov](https://github.com/sloganking/codemov)

Also check out [codevis-gui](https://github.com/sloganking/codevis-gui)

## Renders

This repo's render of [sloganking/My-Own-OS](https://github.com/sloganking/My-Own-OS/tree/6e555c05ce46dcc13904eb41cc4b3ccde61032b5):

![](./assets/code.png)

A readable render of this repo. Zoom in to see the text!

Exact command used: `codevis -i ./ -o /home/username/Pictures/output.png --bg-pixel-color style-checkerboard-darken --readable --line-nums --show-filenames`

![codevis](https://github.com/sloganking/codevis/assets/16965931/3d7b15b3-74dc-44f1-bea6-b2956daa4976)

## CLI Installation

- Install [the Rust programming language.](https://www.rust-lang.org/)

- Run `cargo install codevis`

- You may have to add cargo's binary installation folder (`/home/username/.cargo/bin/` on Linux) to your system's path, if it is not there already.

## CLI Usage

To visualize all files in the current directory and subdirectories. Run `codevis -i ./`. This will store the visualization in a new file called `./output.png`. If you wish to generate an output file with a different name, You can use the `-o` flag like so `codevis -i ./ -o ./different_name.png`.

For a list of more commands run `codevis --help`.