Skip to main content

A distraction-free terminal writing environment for Raspberry Pi

Project description

MicroJournal

MicroJournal turns a Raspberry Pi into a distraction-free terminal writing appliance.

It is built for headless use over SSH, so you do not need a GUI, a custom OS image, or any cloud account to get started.

If you want larger text, raise the font size in your terminal emulator and enable MicroJournal's large UI mode.

Install

uv tool install microjournal

Local development

uv run microjournal

Commands

  • microjournal launches the editor
  • microjournal setup runs first-time configuration
  • microjournal config edits settings
  • microjournal sync syncs notes
  • microjournal export exports notes
  • microjournal pack export writes a shareable visual pack JSON file
  • microjournal pack load applies a visual pack from a JSON file
  • microjournal doctor checks hardware and dependencies
  • microjournal dictate runs push-to-talk local speech-to-text

Storage

  • Notes are stored as Markdown in ~/MicroJournal/notes
  • Config is stored in ~/.config/microjournal/config.toml
  • Autosave is enabled by default and runs every 5 seconds

First run

  1. Run microjournal setup
  2. Choose your notes folder
  3. Pick the display mode, boot behavior, sync placeholder, theme, and large UI preference
  4. Launch microjournal

Editor shortcuts

  • Ctrl+S save
  • Ctrl+N new note
  • Ctrl+F search notes
  • Ctrl+P command palette
  • Ctrl+T theme maker
  • Ctrl+R view note stats
  • Ctrl+E export note stats
  • F8 toggle voice recording
  • Ctrl+Q quit

NLP stats

  • The footer shows live writing stats plus spaCy-powered NLP stats when available
  • Note stats export creates a companion *.ner.md file with entities and summary stats
  • If the en_core_web_sm model is installed, named-entity results are richer

Voice dictation

  • The prototype uses faster-whisper plus microphone capture, all locally
  • Dictated text is inserted into the editor at the cursor
  • Voice mode is push-to-talk: press Voice or F8 to start, then press it again to stop

Accessibility

  • Large UI mode increases spacing, sidebar width, and footer breathing room
  • The app does not force terminal font size; that is still controlled by your terminal emulator
  • Visual packs let you share a theme, palette, and display setup as a JSON file
  • Use the command palette to open the in-app Theme Maker, tweak a pack, and export it for sharing

Roadmap

  • Typing telemetry for sparklines and dashboards, focused on aggregated local writing data rather than raw keystrokes
  • More visual pack presets for cyberdeck-style builds
  • Better export/share flows for Reddit-ready screenshots and pack files

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

microjournal-0.1.0.tar.gz (26.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

microjournal-0.1.0-py3-none-any.whl (24.9 kB view details)

Uploaded Python 3

File details

Details for the file microjournal-0.1.0.tar.gz.

File metadata

  • Download URL: microjournal-0.1.0.tar.gz
  • Upload date:
  • Size: 26.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for microjournal-0.1.0.tar.gz
Algorithm Hash digest
SHA256 c1b5d80580b2b65ccdf98c1b9833adf757162a86dff5ce6c6863f4855078561d
MD5 72d393b32880d52a311b5afcb3f62bcc
BLAKE2b-256 2a8e849b1902e59673b9409c90ac4f02cadc75ab8b0ce88ed9ae09f412955342

See more details on using hashes here.

Provenance

The following attestation bundles were made for microjournal-0.1.0.tar.gz:

Publisher: workflow.yml on elclaudioabierto/microjournal

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file microjournal-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: microjournal-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 24.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for microjournal-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b3e2e1fac2abe4c68eeffdc7940de672d0af79c986eb504189aa3aac4e3c1177
MD5 a6a938d6c59398b8999fcabd19851443
BLAKE2b-256 1e9add83d87ee5d772c43f87acb3c23f25a20e982061675ebfb2c3115d6b8f9a

See more details on using hashes here.

Provenance

The following attestation bundles were made for microjournal-0.1.0-py3-none-any.whl:

Publisher: workflow.yml on elclaudioabierto/microjournal

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page