Skip to content

script.md

Latest commit

 

History

History
61 lines (50 loc) · 1.49 KB

script.md

File metadata and controls

61 lines (50 loc) · 1.49 KB

Script

Overview

Use a Python script to handle all interactions.

Execute from the repository root directory:

uv run python scripts/main.py [COMMAND]

Status

uv run python scripts/main.py status

Returns:

  • Total number of cards
  • Today's review progress (reviewed / total tasks for today)
  • Number of cards due each day for the upcoming week
  • Average retrievability

Generate Cards

uv run python scripts/main.py card new -q "question" -a "answer"

Creates a new card and returns the CARD_ID.

uv run python scripts/main.py card override [CARD_ID] -q "question" -a "answer"

Overrides the question and answer, returns the CARD_ID (keeping it unchanged), and resets the scheduling.

uv run python scripts/main.py card rm [CARD_ID]

Soft deletes the card while preserving the historical review log.

Review

uv run python scripts/main.py review get-question

Returns the CARD_ID and the question (QUESTION).

uv run python scripts/main.py review get-answer

Returns the CARD_ID and the standard answer (ANSWER).

uv run python scripts/main.py review rate [RATING]

RATING options include: again, hard, good, easy.

Returns:

  • Card ID
  • Result of the current rating
  • Historical accuracy
  • Progress of remaining due cards
  • Change in retrievability

Notes

  • You must follow the sequence get-question -> get-answer -> rate; otherwise, a warning will be issued, or the previous question will be repeated.