clsr

README

clsr

clsr stands for Command Line Spaced Repetition. It is a learning tool that uses spaced repetition to help you learn and retain information efficiently. It is similar to other spaced repetition software, but takes a minimalist, text-based, and version-controllable approach.

clsr was inspired by ledger, and more generally by the plain text accounting ecosystem.

How does clsr work?

First, some terms:

A card is a virtual flash card. It contains a question or prompt for something you want to learn, and the answer to that question.
A deck is a group of related cards. For example, you might make a deck for learning French, or for a programming language you want to learn.

In clsr, decks take the form of JSON files. The idea is that you keep all of your deck files in a directory. Then when you run clsr commands from inside that directory, clsr can work with those files. Having these files in one directory also lends itself to the use of version control.

Should I use clsr?

clsr will work well for you if:

• You want to easily understand how your data is stored
• You want to store your card data in version control
• You want to write scripts that use your card data
• You work over SSH, or want the option to do so

You should not use clsr if:

• You are not comfortable with the command line
• You need to include anything other than text (i.e. pictures, sounds) in your cards
• You need fancier features such as cloze and reversed cards

Installation

Binaries are available from the releases page.

Alternatively, you may use go install:

go install github.com/adamkpickering/clsr@latest

Note that if you do this, clsr --version will output development, not a real version. This is because goreleaser or go build with the -ldflags argument is needed to specify the version during the build.

Building from Source

First, install go 1.17 or later and goreleaser. Clone the clsr repo. Then, from the base of that repo:

goreleaser build --clean

Credits

Thanks to SUSE for holding Hack Week 22, which helped to get clsr to the point where it is usable!

Documentation

Overview

Copyright © 2021 ADAM PICKERING

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.