Docs

Study mode

Study mode gives you local tutor-style sessions over your collection without pretending the CLI is a full-screen study app.

Copy this guide

Paste it into Claude, Codex, or OpenClaw for structured context.

Paste this page into your LLM chat for structured context.

When to use this

  • You want an agent or script to drive lightweight study sessions through the terminal.
  • You want a local study layer without mutating Anki review state.

What the agent should know

  • Study sessions are local state layered on collection reads. They do not write review grades back into Anki scheduling.
  • The agent should explicitly reveal before grading and should not assume the CLI mirrors the Anki desktop review screen.

Start a session

Scope the session to a deck or query first so the operator can see exactly what the session is about.

Start and progress

ankicli --json --profile "User 1" study start --deck Default
ankicli --json study next
ankicli --json study details

Reveal, then grade

Reveal the answer before grading. This keeps the flow explicit and easier to supervise.

Reveal and grade

ankicli --json study reveal
ankicli --json study grade --rating good
ankicli --json study summary

Caveats

Study mode is intentionally local and lightweight.

  • Do not treat `study grade` as an Anki scheduling mutation.
  • Use normal note/card commands when you want actual collection changes.