How to install the chord-gen crate // Lib.rs

chord-gen is both an executable binary that can be run, and a library that can be used in Rust programs.

Installing the `chord_cli` executable

Assuming you have Rust/Cargo installed, run this command in a terminal:

cargo install chord-gen

It will make the chord_cli command available in your PATH if you've allowed the PATH to be modified when installing Rust. cargo uninstall chord-gen uninstalls.

Adding `chord_gen` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add chord-gen

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

chord-gen = "2.1.1"

The chord_gen library will be automatically available globally. Read the chord_gen library documentation.

Back to the crate overview.

Readme

Rust library to create guitar chord diagrams in SVG format.

Use it online at chordgenerator.xyz

Usage

This crate contains a library and a command line binary.

Run the cli binary locally with

cargo run -- -f "x,x,x,2,3,2" -p "x,x,x,2,3,1" -t "D"

cargo run -- --help

Creates guitar chord diagrams

Usage: chord_cli [OPTIONS]

Options:
  -f, --frets <FRETS>      Notes to fret, 6 comma-separated values. 0 for open string, -1 to skip a string.
  -p, --fingers <FINGERS>  Suggested fingering, 6 comma-separated values. 0 for open string, x to skip a string.
  -t, --title <TITLE>      Name of chord. Optional.
  -s, --suffix <SUFFIX>    Chord suffix to use in title. Optional.
  -d, --hand <HANDEDNESS>  Left or right handedness. `left` or `right`. Optional, defaults to right.
  -m, --mode <MODE>        Light or dark mode `light` or `dark`. Optional, defaults to light
  -b, --background         Add a background to image
  -h, --help               Print help information
  -V, --version            Print version information

Installing the chord_cli executable

Adding chord_gen library as a dependency

Installing the `chord_cli` executable

Adding `chord_gen` library as a dependency