https://github.com/j6k4m8/chorduroy
Command-line tool to generate chord diagrams for any stringed instrument of any number of frets and strings.
https://github.com/j6k4m8/chorduroy
chords cli commandline golang guitar guitar-chords music
Last synced: 22 days ago
JSON representation
Command-line tool to generate chord diagrams for any stringed instrument of any number of frets and strings.
- Host: GitHub
- URL: https://github.com/j6k4m8/chorduroy
- Owner: j6k4m8
- Created: 2019-08-02T01:27:25.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2019-08-02T16:12:21.000Z (over 5 years ago)
- Last Synced: 2025-02-13T19:46:52.252Z (2 months ago)
- Topics: chords, cli, commandline, golang, guitar, guitar-chords, music
- Language: Go
- Homepage:
- Size: 1.36 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
🎸🎵
chorduroy
Command-line tool to generate chord diagrams for any stringed instrument of any number of frets and strings
---
---
---
---
---
# Downloads
If you don't want to deal with compiling or managing the Go source, **you can download a binary built for your OS from the [releases page](https://github.com/j6k4m8/chorduroy/releases).**
# Example
```shell
chorduroy -f X554X5 -o Am6.png
```
## Usage
```
-f string
Fingering (from highest) (default "X554X5")
-o string
Path at which to save diagram (default "diagram.png")
-s float
Number of frets to include (default 6)
```
`chorduroy` guesses the number of strings on your instrument based upon the fingering you provide. For example, if there are four characters in your fingering, the output will have four strings:
```shell
chorduroy -f 232X -o ukeG.png
```
`chorduroy` will also intelligently guess when a diagram can be "offset" to show chord patterns higher on the fretboard:
```
chorduroy -f 787X -o fretOffset.png
```
## Roadmap
- [ ] Modifiable image size with commandline flags
- [ ] Custom colors and toggleable alpha/transparency
- [ ] SVG / PDF export
- [ ] ASCII output
- [ ] Web service to use online
### Probably not planning on:
- [ ] Barre notation. This is intended to indicate position, not tell you how to play.
- [ ] Fingering suggestions. See above.
- [ ] Instrument-specific notation
## Bonus Theorbo Adom7
