Deploy

.md
cliuv run slp

Starts the local server and opens the notebook in your browser. If a server is already running, it just opens the page.

output
Profile: online
Study app at http://localhost:8321/app/views/notes.html  (ctrl+c to stop)
url
http://localhost:8321/app/views/notes.html, local only (127.0.0.1)
server
Python stdlib, app/server/server.py. No database: it reads and writes topics/

Commands

command what it does
uv run slp start the app
uv run slp setup pick a profile and download the dictation model ahead of time
uv run slp sessions close idle study sessions and print the open ones
uv run slp sessions close close every open study session
uv run slp transcribe <audio> [lang] print the transcription of an audio file

Layout

screen
┌ 1 notes  2 cards  3 exams  4 exercises  5 settings ── clock ── tools ┐
│ explorer │                                                           │
│ topics/  │   the view                                                │
│ index    │                                                           │
└ NORMAL  ~/path  status · session · zoom % · width px · theme · Top ┘
top bar
the five views, a clock, and the tools of the current view
explorer
topics and their contents, per view
status line
mode (NORMAL, INSERT, PASS/FAIL), path, save status, the session control, content zoom, text width, theme picker and scroll position. Zoom and width are remembered per browser
session control
shown when a topic is open. Start or stop a study session by hand; otherwise the app opens one on any activity in the topic and closes it after 30 idle minutes

Views

view what it is
notes list of topics, and the notebook of each one
cards card sets per topic, and the flashcard study
exams list of exams per topic, and the simulator
exercises prompts and your submitted answers per topic, with feedback
settings global (profile, fonts, dictation model), shortcuts, cards and themes. Also at /settings

Markdown formats

The documentation is also available in llms.txt formats:

  • llms.txt lists every documentation page.
  • llms-full.txt contains the complete documentation in one file and may exceed some context windows.

Append .md to any documentation URL to retrieve that page as Markdown. For example, this page is available at https://selflearningplatform.github.io/docs/deploy.md. You can also copy the current page as Markdown by pressing Cmd+C or Ctrl+C.