grimoire grimoiretui.com

A Week with Grimoire · teacher guide

Teach a week of writing

Everything you need to run five lessons: setup, a plan for each day, what to say, what to show, and what to do when a laptop has other ideas.

Student workbook

The week at a glance

Over five days, each student writes a short story (about 1,500 to 2,500 words, though you can pick any length), builds its outline, drafts it in timed sprints, revises it with a partner, and compiles it into a manuscript in the standard format that agents and editors ask for. Along the way they learn a tool that keeps their writing in plain files they own.

DayStudents learn toBy the end they have
1 Open the bookopen a terminal, make a book, move around the desk, write and quita book of their own and a first freewrite
2 Build the bonesplan in three movements, shape the outline, use the corkboarda story plan and a scene card for every scene
3 Draftrun sprints, write in focus mode, leave notes and TKsa messy, brave first draft of most of the story
4 Reviseclear notes, fix spelling and names, trade feedback, read historya revised draft and a partner's notes
5 Publishadd author details, export, read as a reader, reflecta finished manuscript and a certificate
Why a terminal?

It's calm. There are no tabs, notifications or fonts to fiddle with, only the words and the shape of the book. Students also meet a real tool that professionals use every day, and they learn that their work is a folder of files they can open with anything.

Before the week

Give yourself about half an hour, a few days ahead. Most of it is a practice run.

1. Install Grimoire every computer

Open a terminal and paste one line. It installs for the current user, so most machines won't ask for an administrator password.

macOS and Linux (Terminal on a Mac, any terminal on Linux):

curl --proto '=https' --tlsv1.2 -LsSf https://github.com/kelsierbot/GrimoireTUI/releases/latest/download/grimoire-tui-installer.sh | sh

Windows (Windows Terminal or PowerShell):

powershell -ExecutionPolicy Bypass -c "irm https://github.com/kelsierbot/GrimoireTUI/releases/latest/download/grimoire-tui-installer.ps1 | iex"

Then open a new terminal window and check it worked:

grimoire --version

It should answer with a version number and "made by Catfinity Studios".

2. Do a practice run 15 minutes

  • Make a test book: grimoire new ~/Documents/practice, then open it with grimoire ~/Documents/practice.
  • Walk through the Day 1 student handout yourself. You'll spot anything your machines do differently.
  • Try F1, F2 and F9. On some laptops the F-keys need Fn held down; note which ones do.
  • Export once (Esc › Export… › x) and open the Word file, so Day 5 holds no surprises.

3. Decide a few things

  • Story length. 1,500 to 2,500 words suits most high school classes. Younger writers might aim for 800 to 1,200.
  • Where books live. Each student's Documents folder is simplest. On shared computers, put the student's name in the folder: ~/Documents/story-avery. School cloud folders (Google Drive, OneDrive, Dropbox) are fine too: Grimoire never writes over a copy made by another device.
  • PDFs or not. Word files always work, and Google Docs opens them. For PDFs, install LibreOffice (free) on the machines.
  • Music. Grimoire can play music, but it's off until someone turns it on. Leave it off in class.

4. Print

Print each day's student handout, plus the key card and the story planner for Day 1 and 2. The workbook's Print this day buttons make single handouts.

Good to know

Grimoire needs no account, collects nothing, and works without the internet once it's installed. Everything a student writes stays in their book's folder as plain text.

Accessibility

Everything works from the keyboard, and the mouse works too. Make text bigger with the terminal's own zoom (Ctrl +, or Cmd + on a Mac). Nineteen themes offer different contrasts, focus mode hides everything but the words, and Line width in Settings narrows or widens the text.

Day 1 · setup, the desk, first words

Open the book

Student handout →
Goal

Every student makes a book of their own, finds their way around, writes a first scene, and sees that it saves itself.

You'll need
  • Grimoire installed
  • Day 1 handout + key card
  • a projector
Words to know

terminal, command, outline, scene, pane, autosave

The plan 50 minutes

MinWhatHow
0–5Warm-upAsk: where does your writing live? In an app, a website, a notebook? Most apps keep your work somewhere you can't see. This week, you can.
5–12Meet the terminalOpen a terminal on the projector. It's a window where you type commands instead of clicking. Everyone types grimoire --version and presses Enter.
12–20Make a bookTogether: grimoire new ~/Documents/my-story, then grimoire ~/Documents/my-story. The book opens on Novel Format, a short guide to how it's laid out. Read it aloud.
20–28Tour the deskPoint out the outline (left), the page (right), the Pomodoro (under the outline) and the status bar. Show Tab, Esc for the menu, F1 for help, and ↑ ↓ Enter in the outline.
28–40First wordsEveryone opens Chapter One › Scene One, presses Tab and freewrites for ten minutes: someone finds a door that shouldn't be open.
40–45Scavenger huntThe checklist on the handout: find Quit in the menu, read a help topic, try Ctrl-K, find the Trash, pick a theme.
45–48Quit and come backCtrl-Q, then open the book again. It opens right where they left off. If there's time, open the book's folder and show the scene as a plain .md file.
48–50Exit ticketFour quick questions on the handout.

What to say

Say

"You never have to save. Watch the bottom of the screen after you stop typing: it says saved. Your scene is a real file now, in a folder with your name on it."

Say

"Lost? Press Escape. The menu has everything, all the way down to Quit. Press Escape again and you're back where you were."

Demo, step by step

  1. Open a terminal. On Windows the command is grimoire new $HOME\Documents\my-story; the ~ form works on macOS and Linux.
  2. After grimoire new, Grimoire prints the command to open the book. Type it.
  3. In the outline, move down to Manuscript and open Part One › Chapter One › Scene One with Enter.
  4. Press Tab to move to the page. The empty page says Start writing. Type a sentence and wait for saved.
  5. Press Esc to show the menu, then Esc to close it. Press F1 for help, and F1 to close it.

Watch for

Common hiccups
  • "command not found": the terminal was open before installing. Open a new window.
  • Typing does nothing on the page: the outline has the focus. Press Tab or click the page.
  • F-keys open the laptop's own controls: hold Fn, or use Esc › Help… instead of F1.
  • ? types a question mark: on the page it's meant to. Use F1 there.
  • A small, crowded window: make the terminal bigger or full screen; Grimoire tidies itself up to fit.

Support and stretch

Support
  • Pair a confident student with a nervous one.
  • Make the book ahead of time for anyone who struggles with commands.
  • Hand out the key card on day one.
Stretch
  • Try all nineteen themes with F9.
  • Use Ctrl-K to find something without the menu.
  • Read the On disk help topic.

Exit ticket, with answers

  1. How do you open the menu? Esc, from anywhere.
  2. Name two parts of the desk. The outline, the page, the Pomodoro, the status bar.
  3. When is your writing saved? Automatically, a couple of seconds after you stop typing.
  4. How do you quit? Ctrl-Q, or Quit Grimoire at the bottom of the menu.
Day 2 · outline, structure, scene cards

Build the bones

Student handout →
Goal

Students plan a story in three movements, shape the outline to match, and write a card for every scene.

You'll need
  • Day 2 handout
  • the story planner and scene cards
Words to know

part, chapter, scene, synopsis, point of view (POV), status, corkboard

The plan 50 minutes

MinWhatHow
0–5Warm-upPick any story everyone knows and tell it in three sentences: a beginning, a middle and an end.
5–13Three movementsBeginning: who wants what, and where. Middle: what gets in the way, and how it gets worse. End: what changes. Students fill in the story planner.
13–25Shape the outlineA new book has three parts; a short story needs one. Select Part Two, press d, then y: it goes to the Trash. Same for Part Three. Show Ctrl-Z bringing one back, then delete it again. Chapters One, Two and Three become the three movements; rename them with r if students like.
25–33Under the hoodCtrl-Q to quit. Open the book's folder and open novel.toml in a plain text editor. Change title, target_words (say 2000) and daily_target (say 500). Save, reopen Grimoire, and the status bar shows the new target.
33–45Scene cardsIn the outline press b for the corkboard. On each card: e for a one-sentence synopsis, v for whose eyes we're behind, s to set the status to outline. Aim for two or three scenes per chapter; n in the outline adds one.
45–48PitchPartners walk each other through their corkboard in one minute.
48–50Exit ticketOn the handout.

What to say

Say

"Your outline is your folders. A chapter is a folder, a scene is a file. When you rename a scene here, you rename the file. There's no secret database anywhere."

Say

"Deleting is safe. It goes to the Trash at the bottom of the outline, and Ctrl-Z brings it back to exactly where it was."

Watch for

Common hiccups
  • Leftover empty chapters (Four to Nine): they can stay. Empty chapters and scenes are left out when the story is exported.
  • A word processor opens novel.toml and tries to format it: use a plain editor (TextEdit is fine on a Mac, Notepad on Windows, Text Editor on Linux).
  • Each scene says 1,500 words: that's the scene's suggested target, set in its file. For a short story it's only a suggestion, so tell students to aim for a few hundred words per scene.
  • Typing lands in the prose instead of a card: press e or v first, type, then Enter to keep it.

Support and stretch

Support
  • Do the novel.toml step for them beforehand, or skip it.
  • Fill scene cards on paper first, then type them in.
Stretch
  • Move scenes with K and J to try a different order.
  • Press p on the corkboard to see one character's scenes lit up.

Exit ticket, with answers

  1. What is a chapter, on disk? A folder. A scene is a file inside it.
  2. You deleted the wrong thing. What now? Ctrl-Z in the outline, or find it in the Trash.
  3. What goes on a scene card? A synopsis, the point of view, a status, and words against a target.
Day 3 · sprints, focus mode, notes

Draft

Student handout →
Goal

Students draft most of the story without stopping to fix it, using a sprint, focus mode, and notes and TKs.

You'll need
  • Day 3 handout with the sprint log
  • a quiet room for twenty minutes
Words to know

draft, sprint, Pomodoro, focus mode, note, TK ("to come")

The plan 50 minutes

MinWhatHow
0–5Permission slipA first draft is allowed to be bad. Today's rule: don't fix, don't delete. Mark it and keep going.
5–12Show the toolsDemo Esc › Start a sprint…, then Ctrl-D for focus mode. Type a note between %% marks and a TK, and show they're dimmed or bold, and don't count as words.
12–32Sprint oneEveryone starts a sprint: about 300 words in 20 minutes (Tab switches between the two numbers, Enter starts). The status bar counts the sprint. The Pomodoro's sun crosses the sky as the time goes.
32–37Stretch and shareStand up. Read one sentence you like to your partner, no explaining.
37–47Sprint twoTen more minutes, into Chapter Two. Log both sprints on the handout.
47–50Note huntCtrl-T lists every note and TK. Count them; they're tomorrow's to-do list. Exit ticket.

What to say

Say

"Don't know the name of the town? Type TK and keep going. Want to remember to fix something? Put it between two pairs of percent signs. Your notes stay in your file but never reach the story."

Watch for

Common hiccups
  • Students editing instead of drafting: point at the sprint count and remind them of the rule.
  • Lost in focus mode: Ctrl-D again brings the outline back. Esc still opens the menu.
  • Stopping a sprint early: F3, or Stop the sprint in the menu.
  • A scene is full: move to the next scene in the outline, or press n for a new one.

Support and stretch

Support
  • Lower the sprint goal to 150 words.
  • Offer the sentence starters on the handout.
Stretch
  • Raise the goal, or run a third sprint at home.
  • Try typewriter scrolling (on by default in focus mode) and a different Line width in Settings.

Exit ticket, with answers

  1. What does TK mean? "To come": something to fill in later.
  2. Do notes count toward your word count? No, and they never reach the finished story.
  3. How do you see every note and TK at once? Ctrl-T.
Day 4 · notes, spelling, names, feedback, history

Revise

Student handout →
Goal

Students finish the draft, then revise with purpose: clear their notes, fix spelling and names, catch repeated words, and act on a partner's feedback.

You'll need
  • Day 4 handout with the revision checklist and peer form
Words to know

revision, editing, notebook, echo words, history

The plan 50 minutes

MinWhatHow
0–10Finish the draftA short sprint to reach the end. An ending with TKs in it still counts.
10–15Revise vs editRevision is big: does the story work? Editing is small: is each sentence right? Today does both.
15–22CharactersIn the outline's Characters section, n makes a note; name it after the main character. Their name now lights up in the story, and Ctrl-O on it opens the note beside the scene, with every scene they appear in.
22–32The clean-up passCtrl-T to work through notes and TKs. Click underlined words (or F8) for spelling. Ctrl-K, type names, and run Check names for near-miss spellings. Ctrl-K, type echo, and turn on echo words.
32–44Partner notesPartners swap seats and read one scene. They leave feedback as notes in the scene: %% Sam: love this line %%. Notes never reach the story, so nothing they type can spoil it. Back in their seats, Ctrl-T finds every note.
44–48HistoryIn the outline, H on a scene shows its earlier versions and what changed. Set finished scenes to revised on the corkboard with s.
48–50Exit ticketOn the handout.

What to say

Say

"Your partner's notes live right inside your scene, but they'll never show up in your story. Read them, decide, then delete the note or keep it until you've fixed the line."

Watch for

Common hiccups
  • A made-up name is underlined: add a note for the character, or choose Always ignore: this book under the suggestions.
  • A partner typed outside the %% marks: Ctrl-Z undoes it, a word at a time.
  • Restored an old version by mistake: restoring is undoable, and today's words go into history first.

Support and stretch

Support
  • Focus on one pass only: TKs and spelling.
  • Use the peer form on paper instead of notes on screen.
Stretch
  • Show a scene beside the one you're revising with v in the outline.
  • Use Next scene still in draft from the menu to work through the story in order.

Exit ticket, with answers

  1. What's the difference between revising and editing? Revising asks if the story works; editing fixes sentences and words.
  2. How can a partner leave feedback that never reaches your story? As a note between %% marks.
  3. Where can you see how a scene has changed? Its history: H in the outline.
Day 5 · manuscript, reading, reflection

Publish

Student handout →
Goal

Students compile a finished manuscript, read a classmate's as a reader would, and reflect on the week.

You'll need
  • Day 5 handout and certificates
  • LibreOffice, if you want PDFs
Words to know

manuscript, byline, export, standard manuscript format

The plan 50 minutes

MinWhatHow
0–8Last lookCtrl-T should be nearly empty. Check the word count in the status bar. Read the ending one more time.
8–13Author detailsEsc › Settings… › Author details…. The byline is the name on the story. ↑ ↓ move between fields, Esc saves.
13–23ExportEsc › Export…. Make sure Word manuscript is ticked (and PDF, if LibreOffice is installed); Space ticks and unticks. Then press x. The files land in the book's exports folder. Open one together: the title page with the word count, the name and title at the top of each page, a # between scenes, and END.
23–33Reader's eyesSwap and read a partner's manuscript. One compliment, one question, on the handout.
33–38Make it yoursF9 and pick a theme to celebrate. The brave can try Custom….
38–45ShowcaseTwo or three volunteers read their first paragraph aloud.
45–50Look backThe reflection on the handout, and certificates.
Keep students safe

Author details can hold an address and phone number for real submissions. In class, a name (or pen name) and the class name are plenty. Tell students to leave the rest blank.

Watch for

Common hiccups
  • Export stops and lists TKs: that's on purpose, so nothing half-finished slips out. Fill them, or press export again to go ahead anyway.
  • No PDF: LibreOffice isn't installed. The Word file is there; Word or Google Docs can save it as a PDF.
  • Missing chapters in the manuscript: empty scenes are left out on purpose. Check they have words in them.
  • Can't find the file: it's in the book's folder, inside exports, named like Surname_Title_Manuscript.docx.

Support and stretch

Support
  • Export together, step by step, on the projector.
  • Print manuscripts for reading if screens are tight.
Stretch
  • Export an EPUB and open it in an e-reader app.
  • Try Look… in the export box: Courier, A4, a different chapter style.

Exit ticket, with answers

  1. Where do exported files go? The exports folder inside the book.
  2. What's on a manuscript's title page? Contact details, a rounded word count, the title and the byline.
  3. Why did the export stop to list TKs? So nothing unfinished goes out by accident.

Rubric

Score each row from 1 to 4. The process rows reward the habits the week teaches, not only the finished story.

Evidence is built in

A scene's history (H) shows how it changed, the corkboard shows the plan, and Ctrl-T shows what's still unfinished. A quick look at each gives you the process scores without collecting anything extra.

4 · Shines3 · Solid2 · Getting there1 · Beginning
StoryA clear want, rising trouble and a real change; vivid, specific detailA beginning, middle and end that connect; some strong detailThe shape is there but thin, or the ending doesn't followMostly a sketch or a single scene
PlanningA card for every scene, with synopsis, POV and status kept up to dateA card for most scenesA few cards, or the plan was left behindNo plan
DraftingSprints logged; notes and TKs used to keep movingSprints logged; some notes usedDrafted, but stopped often to fixDraft unfinished
RevisionNotes and TKs cleared, names and spelling clean, a partner's feedback acted onMost notes cleared; some feedback usedLight edits onlyNo visible revision
ManuscriptExported with author details, nothing unfinished, read by a partnerExported with author detailsExported, missing detailsNot exported

When things go wrong

What happenedWhat to do
"command not found" after installingClose the terminal and open a new one.
Keys do nothingClick inside the terminal window so it has the focus.
Typing goes nowhereThe outline has the focus. Tab or click the page.
F-keys change volume or brightnessHold Fn, or use the menu (Esc) or Ctrl-K.
Something got deletedCtrl-Z in the outline, or open the Trash at the bottom of the outline.
A scene looks wrong after an editCtrl-Z on the page, or H in the outline for an earlier version.
The laptop died mid-sentenceOpen the book again. Autosave means only the last few seconds can be missing, and anything Grimoire couldn't save is offered back from recovery.
Grimoire opens a different bookOpen the right one by name: grimoire ~/Documents/my-story.
Everything is tiny, or crowdedZoom the terminal (Ctrl + or Cmd +) and make the window bigger.
Anything elseF1 opens the help on the topic for wherever you are, and typing searches every topic.

The student key card

The same card is in the student workbook, ready to print.

Anywhere

Esc
the menu (everything is in it)
F1
help, on the topic for where you are
Ctrl-K
find anything by name
Tab
move to the next pane
Ctrl-Z
undo (Ctrl-Y redo)
Ctrl-Q
quit (it saves first)

The outline

↑ ↓
move
Enter
open a chapter or scene
n · c
new scene · new chapter
r
rename
d
delete (to the Trash)
b
the corkboard
H
a scene's history

Writing

Ctrl-D
focus mode: just your words
F2
start or pause the timer
%% … %%
a note that never reaches the story
TK
"to come": fill it in later
Ctrl-T
every note and TK
F8
spelling (or click the underline)

Corkboard & more

e
edit a card's synopsis
v
edit a card's point of view
s
step its status: idea → done
Ctrl-O
a character's note, beside you
F9
themes (nineteen of them)
Ctrl-F
find in the scene

Adapting the week

  • Younger writers (ages 11 to 13): make the books ahead of time, skip the novel.toml step, and aim for 800 to 1,200 words.
  • College and adult workshops: aim for 3,000 to 5,000 words, add the EPUB and paperback exports on Day 5, and turn on Writing sessions (it needs Git) to see what changed in each sitting.
  • Short on time: fold Day 4 into Day 3's second half and Day 5.
  • One computer per pair: one student types while the other plans and watches the clock, swapping each sprint.
  • Longer projects: the same book grows into a novel. A new book starts with room for 81 scenes in three parts.

Standards

For US classrooms, the week lines up with these Common Core writing standards (grades 9 to 12 shown; the same numbers apply at grades 6 to 8):

  • W.9-10.3 / W.11-12.3: write narratives with well-chosen detail and well-structured events (the whole week).
  • W.9-10.5 / W.11-12.5: develop and strengthen writing by planning, revising and editing (Days 2 and 4).
  • W.9-10.6 / W.11-12.6: use technology to produce and publish writing (Days 1 and 5).
  • W.9-10.10 / W.11-12.10: write routinely, over short and extended time frames (Day 3's sprints).