VocabBot: setup and the plan
Read shared/rules.md first: it says how to call the engine and holds the
rules every VocabBot skill keeps.
python3 "${CLAUDE_SKILL_DIR}/bin/vocabbot.pyz" <command> --json
Step 0: is VocabBot set up?
Run plan show --json.
- It shows a plan: the learner wants a change (B), the terminal program (C)
or a check of the folder (D). Questions about time and progress go to
forecast (A6) and to vocab-coach.
no_learner or no_plan: set it up (A). If the learner says a folder
already exists, pass --learner <folder> and run plan show again.
A. Setup
Courses. course list --json gives the languages and the number of
words per level. Quote these numbers when the learner asks about a course.
Questions, in one message. Which languages (one to three of
angielski, niemiecki, hiszpański, francuski); the level of each
(A1–A2 for beginners, B1–B2 for the intermediate, or "nie wiem", which
calls for the test); new words a day for all languages together (the
default is 15); days off, if any; whether one language should get more
new words than the others (weight 2 against 1).
Placement test. Offer it for every language with an unsure level, and
run it as reference/placement-test.md says. The learner may skip it.
Folder. In Claude Code or a terminal the default is ~/VocabBot; a
folder the learner names works too, and a synced folder (OneDrive,
Dropbox) shares the learning between computers. In Cowork, use the folder
the learner opened for this work. The learner's folder is theirs: never
put it inside the plugin or a project repository.
Preview and yes.
python3 "${CLAUDE_SKILL_DIR}/bin/vocabbot.pyz" init <folder> --lang de:a1-a2 --lang es:b1-b2:2 --new 15 --set days_off=sun --json
--lang is code:levels[:weight]; --set takes any plan key from
reference/plan-keys.md and repeats. Show the preview lines as they
are and ask whether to save. After an explicit yes:
commit --confirm <token> --learner <folder> --json. skipped in its
result means the host's sandbox kept the engine from saving the pointer
in the home folder; later calls then work from the learner's folder as
the current folder, or with --learner <folder>.
Forecast. forecast --days 30 --json: quote average_minutes,
peak_reviews and the days in levels_complete when each level has been
introduced in full.
Next. Offer the first session (vocab-session) and the terminal
program (C).
B. Changing the plan
plan show --json shows the plan in lines. A change is
plan set KEY=VALUE [KEY=VALUE ...] --json, a preview, the learner's yes and
commit --confirm <token> --json. Keys and examples:
reference/plan-keys.md. After a change of the new words a day, the levels
or the languages, run forecast --days 30 --json again and quote it.
The schedule can follow the learner's own log. replay --json replays the
log and compares FSRS-6 with its defaults against the variants fitted to the
earlier part of the log (variants, with scores and delta against
FSRS-6) and simulates the coming weeks (workload). plan fit --json is a
preview: it gives a language parameters of its own only where they predict
the later reviews better than FSRS-6; after the learner's yes, commit
saves them. plan set parameters=default --json goes back to FSRS-6.
C. The terminal program
The same engine runs as the vocabbot program with a coloured session
(vocabbot drill). reference/install.md gives the commands. Installing
software is the learner's decision: show the command and run it only after
their yes.
D. Checking the folder
doctor --json lists problems: damaged rows, conflict copies from a synced
folder, expired previews. doctor --merge --json joins conflict copies of
the log; doctor --repair --json moves damaged rows aside. Both are
previews and need the learner's yes before commit.
More: reference/gotchas.md.
1---2name: vocab-start3description: >4 Set up VocabBot, vocabulary learning in one to three languages at once5 (English, German, Spanish, French; levels A1 to B2) for a Polish speaker:6 choose languages, levels, weights and new words a day, run a short7 placement test, create the learner's folder, change the plan later, show8 the courses and the forecast, check the folder, install the vocabbot9 terminal program. Use when the learner says: set up vocabbot, I want to10 learn German, placement test, change my plan, fewer new words, add Spanish,11 pause French, how long will it take; po polsku: skonfiguruj VocabBota, chcę12 się uczyć niemieckiego, test poziomujący, zmień plan, mniej nowych słów,13 dodaj hiszpański, wstrzymaj francuski, ile to potrwa.14argument-hint: "[languages and levels]"15metadata:16 source: https://skillmd.com/skills/dithiothreitol/vocab-start17---1819# VocabBot: setup and the plan2021Read `shared/rules.md` first: it says how to call the engine and holds the22rules every VocabBot skill keeps.2324```25python3 "${CLAUDE_SKILL_DIR}/bin/vocabbot.pyz" <command> --json26```2728## Step 0: is VocabBot set up?2930Run `plan show --json`.3132- It shows a plan: the learner wants a change (B), the terminal program (C)33 or a check of the folder (D). Questions about time and progress go to34 `forecast` (A6) and to `vocab-coach`.35- `no_learner` or `no_plan`: set it up (A). If the learner says a folder36 already exists, pass `--learner <folder>` and run `plan show` again.3738## A. Setup39401. **Courses.** `course list --json` gives the languages and the number of41 words per level. Quote these numbers when the learner asks about a course.422. **Questions, in one message.** Which languages (one to three of43 angielski, niemiecki, hiszpański, francuski); the level of each44 (A1–A2 for beginners, B1–B2 for the intermediate, or "nie wiem", which45 calls for the test); new words a day for all languages together (the46 default is 15); days off, if any; whether one language should get more47 new words than the others (weight 2 against 1).483. **Placement test.** Offer it for every language with an unsure level, and49 run it as `reference/placement-test.md` says. The learner may skip it.504. **Folder.** In Claude Code or a terminal the default is `~/VocabBot`; a51 folder the learner names works too, and a synced folder (OneDrive,52 Dropbox) shares the learning between computers. In Cowork, use the folder53 the learner opened for this work. The learner's folder is theirs: never54 put it inside the plugin or a project repository.555. **Preview and yes.**5657 ```58 python3 "${CLAUDE_SKILL_DIR}/bin/vocabbot.pyz" init <folder> --lang de:a1-a2 --lang es:b1-b2:2 --new 15 --set days_off=sun --json59 ```6061 `--lang` is `code:levels[:weight]`; `--set` takes any plan key from62 `reference/plan-keys.md` and repeats. Show the `preview` lines as they63 are and ask whether to save. After an explicit yes:64 `commit --confirm <token> --learner <folder> --json`. `skipped` in its65 result means the host's sandbox kept the engine from saving the pointer66 in the home folder; later calls then work from the learner's folder as67 the current folder, or with `--learner <folder>`.686. **Forecast.** `forecast --days 30 --json`: quote `average_minutes`,69 `peak_reviews` and the days in `levels_complete` when each level has been70 introduced in full.717. **Next.** Offer the first session (`vocab-session`) and the terminal72 program (C).7374## B. Changing the plan7576`plan show --json` shows the plan in `lines`. A change is77`plan set KEY=VALUE [KEY=VALUE ...] --json`, a preview, the learner's yes and78`commit --confirm <token> --json`. Keys and examples:79`reference/plan-keys.md`. After a change of the new words a day, the levels80or the languages, run `forecast --days 30 --json` again and quote it.8182The schedule can follow the learner's own log. `replay --json` replays the83log and compares FSRS-6 with its defaults against the variants fitted to the84earlier part of the log (`variants`, with `scores` and `delta` against85FSRS-6) and simulates the coming weeks (`workload`). `plan fit --json` is a86preview: it gives a language parameters of its own only where they predict87the later reviews better than FSRS-6; after the learner's yes, `commit`88saves them. `plan set parameters=default --json` goes back to FSRS-6.8990## C. The terminal program9192The same engine runs as the `vocabbot` program with a coloured session93(`vocabbot drill`). `reference/install.md` gives the commands. Installing94software is the learner's decision: show the command and run it only after95their yes.9697## D. Checking the folder9899`doctor --json` lists problems: damaged rows, conflict copies from a synced100folder, expired previews. `doctor --merge --json` joins conflict copies of101the log; `doctor --repair --json` moves damaged rows aside. Both are102previews and need the learner's yes before `commit`.103104More: `reference/gotchas.md`.