https://github.com/mk6i/flash-card-cli
Command-line audio flash cards for MacOS.
https://github.com/mk6i/flash-card-cli
flash-cards language-learning self-improvement self-study study-aid study-notes
Last synced: 6 months ago
JSON representation
Command-line audio flash cards for MacOS.
- Host: GitHub
- URL: https://github.com/mk6i/flash-card-cli
- Owner: mk6i
- License: apache-2.0
- Created: 2018-01-18T03:16:21.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-01-05T01:59:54.000Z (over 1 year ago)
- Last Synced: 2024-06-21T18:05:42.935Z (over 1 year ago)
- Topics: flash-cards, language-learning, self-improvement, self-study, study-aid, study-notes
- Language: Go
- Homepage:
- Size: 8.79 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Flash Card CLI
Flash Card CLI is a command-line study aid for MacOS. It audibly outputs two-column CSV files in sequence using the built-in `say` command, pausing between entries until the user hits the enter key to continue.
This tool is useful for language learners because it can be configured to output words using foreign voices. For instance, the tool can speak English words in the left column using an English voice and French words in the other using a French voice.
## Installation
Download the Flash Card CLI from the [releases page](https://github.com/mkaminski1988/flash-card-cli/releases) and move it to the `/usr/local/bin` directory.
Quick install:
```bash
curl -O \
-L https://github.com/mkaminski1988/flash-card-cli/releases/download/1.0/flash-macos && \
chmod +x flash-macos && \
sudo mv flash-macos /usr/local/bin/flash
```
## Usage
#### Input File `vocab.csv`
```csv
nageoire (f),flipper
dans le sens des aiguilles d’une montre,clockwise
reculé,"remote, distant"
calotte polaire (f),polar ice cap
vivres (nmpl),food supplies
```
> The voice engine ignores notes written in `(parentheses)`.
Read the left column using Thomas (a French voice) and the right column using Alex (an American English voice).
```bash
cat vocab.csv | flash -left Thomas -right Alex
```
The `-reverse` flag tells the speaker to read the right column before the left column.
```bash
cat vocab.csv | flash -left Thomas -right Alex -reverse
```
Mix it up! Improve retention and recall by randomly sorting multiple input files.
```
cat vocab_1.csv vocab_2.csv | sort -R | flash
```
#### Viewing available voices
MacOS offers plenty of built-in voices for multiple languages. Run the following command to see which voices are available to pass to the `-left` and `-right` flags.
```bash
say -v '?'
```
```bash
Alex en_US # Most people recognize me by my voice.
Alice it_IT # Salve, mi chiamo Alice e sono una voce italiana.
Alva sv_SE # Hej, jag heter Alva. Jag är en svensk röst.
Amelie fr_CA # Bonjour, je m’appelle Amelie. Je suis une voix canadienne.
Anna de_DE # Hallo, ich heiße Anna und ich bin eine deutsche Stimme.
Carmit he_IL # שלום. קוראים לי כרמית, ואני קול בשפה העברית.
Damayanti id_ID # Halo, nama saya Damayanti. Saya berbahasa Indonesia.
[..]
```