@shaankhosla/repeater 0.0.26 → 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +41 -13
- package/README.md +45 -33
- package/npm-shrinkwrap.json +2 -2
- package/package.json +3 -3
package/CHANGELOG.md
CHANGED
|
@@ -1,28 +1,56 @@
|
|
|
1
|
-
## [0.0
|
|
1
|
+
## [0.1.0] - 2026-01-18
|
|
2
2
|
|
|
3
3
|
### 🚀 Features
|
|
4
4
|
|
|
5
|
-
-
|
|
6
|
-
-
|
|
5
|
+
- [**breaking**] Make hashing more robust (#51)
|
|
6
|
+
- Track files traversed in check command (#62)
|
|
7
|
+
- Rephrase questions with AI (#64)
|
|
8
|
+
- Latex math gets converted to unicode (#66)
|
|
9
|
+
- Improve cloze prompt user experience with better formatting and confirmation (#70)
|
|
7
10
|
|
|
8
11
|
### 🐛 Bug Fixes
|
|
9
12
|
|
|
10
|
-
-
|
|
11
|
-
-
|
|
13
|
+
- Add linux persistence for llm keys
|
|
14
|
+
- FSRS stats will show despite no cards being due (#69)
|
|
15
|
+
- Incorrect API key not failing (#71)
|
|
16
|
+
- `create` command works with new file (#72)
|
|
12
17
|
|
|
13
18
|
### 💼 Other
|
|
14
19
|
|
|
15
|
-
- *(deps)* Bump
|
|
16
|
-
-
|
|
17
|
-
- *(deps)* Bump
|
|
20
|
+
- *(deps)* Bump blake3 from 1.8.2 to 1.8.3 (#55)
|
|
21
|
+
- *(deps)* Bump serde_json from 1.0.148 to 1.0.149 (#57)
|
|
22
|
+
- *(deps)* Bump async-openai from 0.30.1 to 0.32.3 (#56)
|
|
23
|
+
- *(deps)* Bump keyring from 2.3.3 to 3.6.3 (#54)
|
|
18
24
|
|
|
19
25
|
### 🚜 Refactor
|
|
20
26
|
|
|
21
|
-
-
|
|
27
|
+
- Reorganize code (#58)
|
|
28
|
+
- Unify theming (#60)
|
|
29
|
+
- Improve cicd (#61)
|
|
30
|
+
- Reduce user prompts for keychain password (#63)
|
|
31
|
+
- Improve Anki import significantly with logging and code refactor (#65)
|
|
32
|
+
- Break out user prompts to separate file (#67)
|
|
33
|
+
- Cicd and tests (#68)
|
|
22
34
|
|
|
23
35
|
### 📚 Documentation
|
|
24
36
|
|
|
25
|
-
-
|
|
26
|
-
-
|
|
27
|
-
|
|
28
|
-
|
|
37
|
+
- Readme improvements (#52)
|
|
38
|
+
- Show star history
|
|
39
|
+
|
|
40
|
+
### 🧪 Testing
|
|
41
|
+
|
|
42
|
+
- Increase test coverage (#59)
|
|
43
|
+
|
|
44
|
+
### ⚙️ Miscellaneous Tasks
|
|
45
|
+
|
|
46
|
+
- Update author/license
|
|
47
|
+
- Fix failing cicd
|
|
48
|
+
- Add install
|
|
49
|
+
- *(release)* V0.1.0
|
|
50
|
+
- Fix cicd
|
|
51
|
+
- *(release)* V0.1.0
|
|
52
|
+
- Fix cicd
|
|
53
|
+
- *(release)* V0.1.0
|
|
54
|
+
- *(release)* V0.1.0
|
|
55
|
+
- Fix cicd
|
|
56
|
+
- Fix cicd
|
package/README.md
CHANGED
|
@@ -18,46 +18,30 @@
|
|
|
18
18
|
`repeater` is a command-line flashcard program that uses [spaced repetition](https://en.wikipedia.org/wiki/Spaced_repetition) to boost your memory retention. It’s like a lightweight, text-based Anki you run in your terminal. Your decks are kept in Markdown, progress is tracked in SQLite, and reviews are scheduled with Free Spaced Repetition Scheduler (FSRS), a state-of-the-art algorithm targeting 90% recall.
|
|
19
19
|
|
|
20
20
|
|
|
21
|
+
> *"Just tested this out and it's amazing! The ability to simply use the same file to take your notes (e.g., in class) and as your flashcards source file is a serious game-changer. I love how minimalist it is, too."*
|
|
22
|
+
> — Reddit user
|
|
23
|
+
|
|
21
24
|
<img src="check_example.png" alt="Checking card progress" />
|
|
22
25
|
|
|
23
26
|
> [!NOTE]
|
|
24
27
|
> You can find the main documentation, including installation guides, at [https://shaankhosla.github.io/repeater/](https://shaankhosla.github.io/repeater/).
|
|
25
28
|
|
|
26
|
-
##
|
|
27
|
-
|
|
28
|
-
- **Markdown-first decks**: write basic Q/A + cloze cards in plain `.md` alongside your notes.
|
|
29
|
-
- **Stable card identity**: “meaning-only” hashing; formatting tweaks don’t reset progress.
|
|
30
|
-
- **FSRS scheduling**: automatic reviews targeting ~90% recall (simple Pass/Fail).
|
|
31
|
-
- **Terminal workflow**: drill TUI, capture editor, and progress dashboard (`drill`, `create`, `check`).
|
|
32
|
-
- **Media + migration**: open linked images/audio/video; import Anki `.apkg` to Markdown.
|
|
33
|
-
- **Optional LLM helper**: add an OpenAI key once and missing Cloze brackets are auto-suggested before drills.
|
|
29
|
+
## How is this different than Anki?
|
|
34
30
|
|
|
31
|
+
[Anki](https://apps.ankiweb.net) is a powerful and flexible spaced-repetition system with a mature GUI, mobile apps, and a large plugin ecosystem. If you want a highly customizable study system, Anki is an excellent choice.
|
|
35
32
|
|
|
36
|
-
|
|
33
|
+
`repeater` takes a different approach. Instead of asking you to move your active-recall material into a separate application, your notes themselves are the source of truth. Flashcards live directly inside plain Markdown files, alongside regular notes, and are detected automatically. There is no card editor, no syncing layer, and no separate “collection” to manage.
|
|
37
34
|
|
|
38
|
-
|
|
35
|
+
In practice, this means less flexibility but much less friction. You edit cards the same way you edit notes, using the same tools, and can easily inspect, version, or refactor your material without exports or migrations. The goal is not to replace Anki’s ecosystem, but to offer a simpler, text-first workflow for people who prefer minimalism, the terminal, and plain files over feature depth.
|
|
39
36
|
|
|
40
|
-
|
|
41
|
-
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/shaankhosla/repeater/releases/latest/download/repeater-installer.sh | sh
|
|
42
|
-
```
|
|
43
|
-
|
|
44
|
-
### Homebrew (macOS)
|
|
45
|
-
|
|
46
|
-
```
|
|
47
|
-
brew install shaankhosla/tap/repeater
|
|
48
|
-
```
|
|
49
|
-
|
|
50
|
-
### Windows (PowerShell)
|
|
51
|
-
|
|
52
|
-
```
|
|
53
|
-
irm https://github.com/shaankhosla/repeater/releases/latest/download/repeater-installer.ps1 | iex
|
|
54
|
-
```
|
|
37
|
+
## Features
|
|
55
38
|
|
|
56
|
-
|
|
39
|
+
- **Markdown-first decks**: write basic Q/A + cloze cards in plain `.md` alongside your notes.
|
|
40
|
+
- **Media support**: open linked images/audio/video.
|
|
41
|
+
- **Anki import**: import your existing Anki decks `.apkg` to Markdown.
|
|
42
|
+
- **Stable card identity**: “meaning-only” hashing; formatting tweaks don’t reset progress.
|
|
43
|
+
- **Optional LLM helper**: add an OpenAI key once to auto-suggest missing Cloze brackets and optionally rephrase basic questions (see the [docs](https://shaankhosla.github.io/repeater/llm-usage.html)).
|
|
57
44
|
|
|
58
|
-
```
|
|
59
|
-
npm install @shaankhosla/repeater
|
|
60
|
-
```
|
|
61
45
|
|
|
62
46
|
## Quick Start
|
|
63
47
|
|
|
@@ -85,8 +69,36 @@ npm install @shaankhosla/repeater
|
|
|
85
69
|
repeater drill cards
|
|
86
70
|
```
|
|
87
71
|
|
|
88
|
-
- `Space`/`Enter`: reveal the answer or cloze.
|
|
89
|
-
- `O`: open the first media file (image/audio/video) referenced in the current card before revealing the answer.
|
|
90
|
-
- `F`: mark as `Fail`, `Space`/`Enter`: mark as `Pass`.
|
|
91
|
-
- `Esc` or `Ctrl+C`: end the session early (progress so far is saved).
|
|
92
72
|
|
|
73
|
+
That's it! `repeater` will automatically track progress and schedule reviews.
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
## Installation
|
|
77
|
+
|
|
78
|
+
### Install script (Linux & macOS) - Recommended
|
|
79
|
+
|
|
80
|
+
```
|
|
81
|
+
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/shaankhosla/repeater/releases/latest/download/repeater-installer.sh | sh
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
### Homebrew (macOS)
|
|
85
|
+
|
|
86
|
+
```
|
|
87
|
+
brew install shaankhosla/tap/repeater
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
### Windows (PowerShell)
|
|
91
|
+
|
|
92
|
+
```
|
|
93
|
+
irm https://github.com/shaankhosla/repeater/releases/latest/download/repeater-installer.ps1 | iex
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
### npm
|
|
97
|
+
|
|
98
|
+
```
|
|
99
|
+
npm install @shaankhosla/repeater
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
## Star History
|
|
103
|
+
|
|
104
|
+
[](https://www.star-history.com/#shaankhosla/repeater&type=date&legend=top-left)
|
package/npm-shrinkwrap.json
CHANGED
|
@@ -22,7 +22,7 @@
|
|
|
22
22
|
},
|
|
23
23
|
"hasInstallScript": true,
|
|
24
24
|
"name": "@shaankhosla/repeater",
|
|
25
|
-
"version": "0.0
|
|
25
|
+
"version": "0.1.0"
|
|
26
26
|
},
|
|
27
27
|
"node_modules/@isaacs/balanced-match": {
|
|
28
28
|
"engines": {
|
|
@@ -514,5 +514,5 @@
|
|
|
514
514
|
}
|
|
515
515
|
},
|
|
516
516
|
"requires": true,
|
|
517
|
-
"version": "0.0
|
|
517
|
+
"version": "0.1.0"
|
|
518
518
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
|
-
"artifactDownloadUrl": "https://github.com/shaankhosla/repeater/releases/download/v0.0
|
|
3
|
-
"author": "
|
|
2
|
+
"artifactDownloadUrl": "https://github.com/shaankhosla/repeater/releases/download/v0.1.0",
|
|
3
|
+
"author": "Shaan Khosla <shaan.khosla@proton.me>",
|
|
4
4
|
"bin": {
|
|
5
5
|
"repeater": "run-repeater.js"
|
|
6
6
|
},
|
|
@@ -83,7 +83,7 @@
|
|
|
83
83
|
"zipExt": ".tar.xz"
|
|
84
84
|
}
|
|
85
85
|
},
|
|
86
|
-
"version": "0.0
|
|
86
|
+
"version": "0.1.0",
|
|
87
87
|
"volta": {
|
|
88
88
|
"node": "18.14.1",
|
|
89
89
|
"npm": "9.5.0"
|