Skip to main content

Commands

Every command, option and key the coach CLI understands. Run any command as:

npm run coach -- <command>

Every change to your vault is shown first. Nothing is written, moved or recorded until you confirm.

Commands​

CommandWhat it does
dueWhat's due for review today, and what has never been sparred. The default when you type no command.
listEvery note in Resources with how well you know it: unsparred, attempted, Tier 1 passed, Tier 2 passed.
synthesize [book]Turn your marks and reading notes on a book into concept notes. Without a book, you pick one from a list.
spar [note …]Tier 1, offline. Spar the notes that are due, or the notes you name (by path or coach id).
judge [session …]Tier 2, online. Judge the sparring sessions waiting for it.
study <note>Work through the gaps from a note's latest failed session.
capture <title>Write a quick note into 0.Inbox. End it with a line holding a single ..
file <note> <folder>Move a note into a PARA folder, e.g. file "0.Inbox/Idea.md" 3.Resources/TypeScript. Without arguments, lists what's waiting to be filed.
archive <project>Move a finished project into 4.Archive. It first asks which concept and sparred notes to keep in Resources.
initSet up the five PARA folders in your vault.
viewOpen the vault graph in your browser at http://127.0.0.1:4747/, where you can also mark chapters. /plans shows your plans.

Options​

OptionMeaning
--style <style>Coach in this style for this run. See Coaching styles.
--config <file>Use a different configuration file.
--today YYYY-MM-DDPretend it's another day, e.g. to see what will be due next week.
--help, -hShow the command list.

While you answer​

TypeTo
an empty linesend your answer (answers can span several lines)
/skipskip this note, question or gap
/quitstop; nothing is recorded unless you confirm it
/hint or "teach me"in study: get a clue and the author's words, without losing a try

Exit codes​

CodeMeaning
0success
1an error the coach explained
2a usage error: unknown command or bad option