Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/janlelis/uke

𝄝 Ukulele CLI Support
https://github.com/janlelis/uke

chords ukulele

Last synced: 3 months ago
JSON representation

𝄝 Ukulele CLI Support

Host: GitHub
URL: https://github.com/janlelis/uke
Owner: janlelis
License: mit
Created: 2015-07-02T17:03:45.000Z (over 9 years ago)
Default Branch: main
Last Pushed: 2021-01-01T21:13:12.000Z (almost 4 years ago)
Last Synced: 2024-07-17T06:45:33.815Z (4 months ago)
Topics: chords, ukulele
Language: Ruby
Homepage:
Size: 14.6 KB
Stars: 13
Watchers: 5
Forks: 2
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: MIT-LICENSE.txt

Awesome Lists containing this project

Open-Source-Ruby-and-Rails-Apps - uke - 🎶 Ukulele CLI Support 🔥 (Happy Exploring 🤘)

README

# uke gem [![[version]](https://badge.fury.io/rb/uke.svg)](https://badge.fury.io/rb/uke)

Displays popular ukulele chords for the popular `GCEA` tuning like this:

```
$ uke-chords G B7 C Cm

⚪
╒══╤══╤══╕ ╒══╤══╤══╕
_____ │ │ │ │ │ │ │ │
/ ____| ├──┼──┼──┤ ├──┼──┼──┤
| | __ │ ● │ ● │ ● │ ●
| | |_ | ├──┼──┼──┤ ├──┼──┼──┤
| |__| | │ │ ● │ │ │ ● │
\_____| ├──┼──┼──┤ ├──┼──┼──┤
│ │ │ │ ● │ │ │
└──┴──┴──┘ └──┴──┴──┘

⚪
╒══╤══╤══╕ ╒══╤══╤══╕
____ ______ │ │ │ │ │ │ │ │
| _ \____ | ├──┼──┼──┤ ├──┼──┼──┤
| |_) | / / ● │ ● ● │ │ ● │
| _ < / / ├──┼──┼──┤ ├──┼──┼──┤
| |_) |/ / │ ● │ │ │ ● │ │
|____//_/ ├──┼──┼──┤ ├──┼──┼──┤
│ │ │ │ ● │ │ │
└──┴──┴──┘ └──┴──┴──┘

⚪ ⚪ ⚪ ⚪ ⚪ ⚪
╒══╤══╤══╕ ╒══╤══╤══╕ ╒══╤══╤══╕
_____ │ │ │ │ │ │ │ │ │ │ │ │
/ ____| ├──┼──┼──┤ ├──┼──┼──┤ ├──┼──┼──┤
| | │ │ │ │ │ │ │ │ │ │ │ │
| | ├──┼──┼──┤ ├──┼──┼──┤ ├──┼──┼──┤
| |____ │ │ │ ● │ │ │ ● │ │ ● ●
\_____| ├──┼──┼──┤ ├──┼──┼──┤ ├──┼──┼──┤
│ │ │ │ │ ● │ │ │ ● │ │
└──┴──┴──┘ └──┴──┴──┘ └──┴──┴──┘

⚪
╒══╤══╤══╕
_____ │ │ │ │
/ ____| ├──┼──┼──┤
| | _ __ ___ │ │ │ │
| | | '_ ` _ \ ├──┼──┼──┤
| |____| | | | | | │ ● ● ●
\_____|_| |_| |_| ├──┼──┼──┤
│ │ │ │
└──┴──┴──┘

```

You can also get suggestions which fingers to use with the `--style fingering` option:

```
$ uke-chords --style fingering C

◯ ◯ ◯ ◯ ◯ ◯
╒══╤══╤══╕ ╒══╤══╤══╕ ╒══╤══╤══╕
_____ │ │ │ │ │ │ │ │ │ │ │ │
/ ____| ├──┼──┼──┤ ├──┼──┼──┤ ├──┼──┼──┤
| | │ │ │ │ │ │ │ │ │ │ │ │
| | ├──┼──┼──┤ ├──┼──┼──┤ ├──┼──┼──┤
| |____ │ │ │ ➊ │ │ │ ➊ │ │ ➊ ➊
\_____| ├──┼──┼──┤ ├──┼──┼──┤ ├──┼──┼──┤
│ │ │ │ │ ➋ │ │ │ ➋ │ │
└──┴──┴──┘ └──┴──┴──┘ └──┴──┴──┘
```

## Setup

Make sure that your computer has Ruby 2.0 or higher installed. Then run

```ruby
gem install uke
```

## Usage

On the command-line, run `uke-chords`, followed by the chords you want to display (see the example at top).

Run `uke-chords` without any parameters for a list of included chords.

## MIT License