kovid-r / clime

A compact and visually appealing avatar of your resume on the command line.

clime

clime is a compact and visually appealing avatar of your resume on the command line.

Usage

Clone the repository

Clone this repository using the following command:

git clone [e-mail]:kovid-r/clime.git

Install Node.js dependencies

Make sure you have Node.js >= 14 installed on your machine. Use the following commands to install dependencies if you want to build package-lock.json again:

cd clime
npm install --save

Run clime

Run clime using the following command:

node clime.js

Color pallette from Coolors, except that for hyperlinks.

Configuration

clime.json

This is a custom representation of your resume. I discovered jsonresume after I had written a little bit of code. I might additional support for jsonresume later. Use clime.json to add your contact infromation, GitHub username (for GitHub stats), work history, projects, certifications, and social media links.

Note: clime is currently only tested on iTerm. It may not support hyperlink rendition on other terminals. clime uses terminalLink. Using that, I'll add support for other terminals too.

style.json

Set the useThis field to true in this file to force clime to use custom specified colors. If useThis is set to false, clime will use the color-scheme package by c0bra and allot colors for a list of 16 colors (this can be tweaked).

Credits

Inspired by simiar projects done by anmol908 and jackboberg.