aschord

Crates.ioaschord
lib.rsaschord
version0.3.4
sourcesrc
created_at2022-09-17 20:11:56.106712
updated_at2022-11-01 13:13:19.513508
descriptionA command line tool for showing how to play guitar chords
homepagehttps://github.com/yzhong52/ascii_chords
repositoryhttps://github.com/yzhong52/ascii_chords
max_upload_size
id668327
size44,134
Yuchen (yzhong52)

documentation

README

Ascii Chord

A command line tool for showing how to play guitar chords

Usage

For a single chord:

$ aschord get G

This is how you play 'G' chord: 
    ◯ ◯ ◯  
┌─┬─┬─┬─┬─┐
│ │ │ │ │ │
├─┼─┼─┼─┼─┤
│ ◯ │ │ │ │
├─┼─┼─┼─┼─┤
◯ │ │ │ │ ◯
└─┴─┴─┴─┴─┘

For multiple chords:

$ aschord list Em Esus4 Asus2 F

Em             Esus4          Asus2          F              
◯     ◯ ◯ ◯    ◯       ◯ ◯    x ◯     ◯ ◯                   
╒═╤═╤═╤═╤═╕    ╒═╤═╤═╤═╤═╕    ╒═╤═╤═╤═╤═╕    ╒═╤═╤═╤═╤═╕    
│ │ │ │ │ │    │ │ │ │ │ │    │ │ │ │ │ │    ◯-------◯-◯    
├─┼─┼─┼─┼─┤    ├─┼─┼─┼─┼─┤    ├─┼─┼─┼─┼─┤    ├─┼─┼─┼─┼─┤    
│ ◯ ◯ │ │ │    │ ◯ ◯ ◯ │ │    │ │ ◯ ◯ │ │    │ │ │ ◯ │ │    
├─┼─┼─┼─┼─┤    ├─┼─┼─┼─┼─┤    ├─┼─┼─┼─┼─┤    ├─┼─┼─┼─┼─┤    
│ │ │ │ │ │    │ │ │ │ │ │    │ │ │ │ │ │    │ ◯ ◯ │ │ │    
├─┼─┼─┼─┼─┤    ├─┼─┼─┼─┼─┤    ├─┼─┼─┼─┼─┤    ├─┼─┼─┼─┼─┤    
│ │ │ │ │ │    │ │ │ │ │ │    │ │ │ │ │ │    │ │ │ │ │ │    
└─┴─┴─┴─┴─┘    └─┴─┴─┴─┴─┘    └─┴─┴─┴─┴─┘    └─┴─┴─┴─┴─┘   

For different ways to play the same chord:

$ aschord list Bm --style full-name

B minor           B minor (no bar)
                  x x             
╒═╤═╤═╤═╤═╕       ╒═╤═╤═╤═╤═╕     
│ │ │ │ │ │       │ │ │ │ │ │     
├─┼─┼─┼─┼─┤       ├─┼─┼─┼─┼─┤     
◯-◯-------◯       │ │ │ │ │ ◯     
├─┼─┼─┼─┼─┤       ├─┼─┼─┼─┼─┤     
│ │ │ │ ◯ │       │ │ │ │ ◯ │     
├─┼─┼─┼─┼─┤       ├─┼─┼─┼─┼─┤     
│ │ ◯ ◯ │ │       │ │ ◯ ◯ │ │     
└─┴─┴─┴─┴─┘       └─┴─┴─┴─┴─┘     

For multiple chords with full names:

$ aschord list Em Esus4 Asus2 F --style full-name

E minor          E suspended 4th  A suspended 2nd  F major    
◯     ◯ ◯ ◯      ◯       ◯ ◯      x ◯     ◯ ◯                 
╒═╤═╤═╤═╤═╕      ╒═╤═╤═╤═╤═╕      ╒═╤═╤═╤═╤═╕      ╒═╤═╤═╤═╤═╕
│ │ │ │ │ │      │ │ │ │ │ │      │ │ │ │ │ │      ◯-------◯-◯
├─┼─┼─┼─┼─┤      ├─┼─┼─┼─┼─┤      ├─┼─┼─┼─┼─┤      ├─┼─┼─┼─┼─┤
│ ◯ ◯ │ │ │      │ ◯ ◯ ◯ │ │      │ │ ◯ ◯ │ │      │ │ │ ◯ │ │
├─┼─┼─┼─┼─┤      ├─┼─┼─┼─┼─┤      ├─┼─┼─┼─┼─┤      ├─┼─┼─┼─┼─┤
│ │ │ │ │ │      │ │ │ │ │ │      │ │ │ │ │ │      │ ◯ ◯ │ │ │
├─┼─┼─┼─┼─┤      ├─┼─┼─┼─┼─┤      ├─┼─┼─┼─┼─┤      ├─┼─┼─┼─┼─┤
│ │ │ │ │ │      │ │ │ │ │ │      │ │ │ │ │ │      │ │ │ │ │ │
└─┴─┴─┴─┴─┘      └─┴─┴─┴─┴─┘      └─┴─┴─┴─┴─┘      └─┴─┴─┴─┴─┘

Changing the style of the output:

$ aschord -f ♥ get G    
This is how you play 'G major' chord: 
    ◯ ◯ ◯  
╒═╤═╤═╤═╤═╕
│ │ │ │ │ │
├─┼─┼─┼─┼─┤
│ ♥ │ │ │ │
├─┼─┼─┼─┼─┤
♥ │ │ │ │ ♥
├─┼─┼─┼─┼─┤
│ │ │ │ │ │
└─┴─┴─┴─┴─┘

For all support chords:

$ aschord all

Also see all supported chords here (auto-generated, do not edit).

Installation

Install local version:

git clone git@github.com:yzhong52/ascii_chord.git
cd ascii_chord
cargo install --path .

Install from https://crates.io/crates/aschord:

cargo install aschord

Development

Build & Run

Show a single chord:

cargo run -- G

Show multiple chords:

cargo run -- list Em Esus4 Asus2 Fm D Am

Show all chords:

cargo run -- all

Unit Tests

cargo test

Release

cargo publish
Commit count: 21

cargo fmt