Skip to content

Latest commit

 

History

History
41 lines (30 loc) · 1.06 KB

README.md

File metadata and controls

41 lines (30 loc) · 1.06 KB

ducki

Study flashcards from the comfort of your terminal to minimize distractions. Schedules cards using the Free Spaced Repetition Scheduler (FSRS) for maximized learning.

NOTE: This project us very much a WIP and commands/config files are subject to change before the first full release. This is one of my first Rust projects so it's a bit messy :)

Commands

  • list|ls List all decks
  • init|i [slug] Add a new deck
  • add [path] Add an existing deck
  • remove|rm [slug] Remove a deck
  • study [slug] Study a deck
  • deck
    • add [slug] [id] [front] [back] Add a card to a deck
    • remove|rm [slug] [id] Remove a card from a deck
    • help [command] display help for command

Get started

  1. Create a new deck with ducki init
  2. Add a card to the deck with ducki deck add
  3. Study the new deck with ducki study

Building

Host-only

cargo build

Cross-platform

cargo install cross --git https://github.com/cross-rs/cross
./build.sh

License

Copyright © 2024 Sigfredo. Licensed under the MIT License