codevis is both an executable binary that can be run, and a library that can be used in Rust programs.
Installing the command-line executable
Assuming you have Rust/Cargo installed , run this command in a terminal:
cargo install codevis
It will make the codevis command available in your PATH if you've allowed the PATH to be modified when installing Rust . cargo uninstall codevis uninstalls.
Adding codevis library as a dependency
Run this command in a terminal, in your project's directory:
cargo add codevis
To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:
codevis = "0.8.4"
The codevis library will be automatically available globally.
Read the codevis library documentation .
Back to the crate overview .
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. Looking for a video instead of an image? Check out this repo's sister project codemov
This repo's render of sloganking/My-Own-OS :
CLI Installation
Install the Rust programming language.
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 .