Skip to main content

Local voice note-taking suite

Project description

voxn

voxn is a local-first note and memory CLI for Linux. It captures voice or text notes, stores them as Markdown under ~/.local/share/voxn/, indexes them into SQLite FTS5, and exposes search, context, browse, ingest, and digest commands.

The default LLM path uses local Ollama. Remote OpenAI-compatible providers are optional; storage remains local.

Install

For a Python-only install from a checkout:

git clone https://github.com/okrinoggen33/voxn.git voxn-project
cd voxn-project
uv tool install -e '.[voice,whisper]'

For the full voice workflow, install system tools separately:

# Arch example
sudo pacman -S portaudio sqlite wl-clipboard libnotify poppler
sudo pacman -S ollama    # or ollama-rocm

Then start Ollama and pull a model:

systemctl enable --now ollama
ollama pull gemma3:12b
voxn doctor

Quick Start

voxn add -p my-project "Capture this decision"
voxn doctor
voxn index --rebuild
voxn search -p my-project "decision"
voxn context -p my-project

Voice capture uses the bare command as a toggle:

voxn          # start recording
voxn          # stop, transcribe, format, and save

Main Commands

  • voxn add: save direct text or stdin as a structured note.
  • voxn ingest: summarize a file, URL, PDF, video, or stdin into notes.
  • voxn index: rebuild the SQLite search index from Markdown notes.
  • voxn remove: remove one indexed note from Markdown and SQLite.
  • voxn search: search indexed notes by text, project, category, tag, or date.
  • voxn context: emit a prompt-ready project memory block for agents.
  • voxn browse: browse notes or generated wiki pages in the Textual TUI.
  • voxn digest: generate local wiki pages from notes.
  • voxn doctor: check dependencies and bootstrap configured data paths.

Configuration

Default local paths:

  • Notes: ~/.local/share/voxn/voxns.md
  • SQLite DB: ~/.local/share/voxn/notes.db
  • Wiki output: ~/.local/share/voxn/wiki/

voxn doctor creates those paths and initializes the DB when they are missing.

Configuration is read from ${XDG_CONFIG_HOME:-~/.config}/voxn/config.toml when present, then overridden by environment variables. Common environment variables:

  • VOXN_CONFIG_FILE
  • VOXN_NOTES_FILE
  • VOXN_DB
  • VOXN_DIGEST_DIR
  • VOXN_LLM_PROVIDER
  • VOXN_LLM_MODEL
  • VOXN_LLM_BASE_URL

More Documentation

The repository README contains the full install guide, systemd user units, AUR packaging notes, architecture details, and contributor documentation:

https://github.com/okrinoggen33/voxn

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

voxn-0.3.2.tar.gz (56.2 kB view details)

Uploaded Source

Built Distribution

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

voxn-0.3.2-py3-none-any.whl (39.6 kB view details)

Uploaded Python 3

File details

Details for the file voxn-0.3.2.tar.gz.

File metadata

  • Download URL: voxn-0.3.2.tar.gz
  • Upload date:
  • Size: 56.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.5

File hashes

Hashes for voxn-0.3.2.tar.gz
Algorithm Hash digest
SHA256 c8e66b0618ffd781f41c4a25f5fffdf1aed75f6a9dde4943740cacd66e67620b
MD5 f5b0bcb679b69543e98ab759c8e25850
BLAKE2b-256 038690bb2311f6d9c69393aed6a2bb649f6a95ce731c9713a51dbcd6d57a7d81

See more details on using hashes here.

File details

Details for the file voxn-0.3.2-py3-none-any.whl.

File metadata

  • Download URL: voxn-0.3.2-py3-none-any.whl
  • Upload date:
  • Size: 39.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.5

File hashes

Hashes for voxn-0.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d15debe5b7d1184915e06930ab3340a580781f3ed880f6cf19050ef3fae9e378
MD5 47954bf0b83295409ea0d1d27b596c58
BLAKE2b-256 3c8a6882862b8870c5994bba39a3cc79f27db667fc4e07c9830426f1a483e256

See more details on using hashes here.

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