internal/

directory
v0.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 17, 2026 License: MIT

Directories

Path Synopsis
Package backend is the seam that lets every zn command and the terminal UI work against a vault on this machine or one behind a self-hosted ZenNotes server: the same operations, bound either to a root on disk or to a server over HTTP.
Package backend is the seam that lets every zn command and the terminal UI work against a vault on this machine or one behind a self-hosted ZenNotes server: the same operations, bound either to a root on disk or to a server over HTTP.
Package cli is the `zn` command surface: the same commands, flags, output and JSON shapes as the CLI the desktop app bundles, plus `zn tui`.
Package cli is the `zn` command surface: the same commands, flags, output and JSON shapes as the CLI the desktop app bundles, plus `zn tui`.
Package config reads what the desktop app writes: the runtime config (`zennotes.config.json`, where the known vaults and saved servers live) and the portable preferences (`config.toml`).
Package config reads what the desktop app writes: the runtime config (`zennotes.config.json`, where the known vaults and saved servers live) and the portable preferences (`config.toml`).
Package database reads and writes ZenNotes databases: a `<Name>.base/` folder holding `data.csv`, a `schema.json` sidecar and record-page notes.
Package database reads and writes ZenNotes databases: a `<Name>.base/` folder holding `data.csv`, a `schema.json` sidecar and record-page notes.
Package keymaps is the bindable-action catalog the terminal UI consults: the same action ids and default bindings as the desktop's keymap table, so a `[keymaps]` override in config.toml means the same thing in both.
Package keymaps is the bindable-action catalog the terminal UI consults: the same action ids and default bindings as the desktop's keymap table, so a `[keymaps]` override in config.toml means the same thing in both.
Package mcp is the ZenNotes MCP server: the vault operations exposed as tools, with a note-taker-focused system instruction, over stdio.
Package mcp is the ZenNotes MCP server: the vault operations exposed as tools, with a note-taker-focused system instruction, over stdio.
Package periodic locates daily, weekly and monthly notes from the vault's directory and title patterns, and formats dates for template variables.
Package periodic locates daily, weekly and monthly notes from the vault's directory and title patterns, and formats dates for template variables.
Package remote talks to a self-hosted ZenNotes server over its HTTP API, the same routes the desktop and web clients use.
Package remote talks to a self-hosted ZenNotes server over its HTTP API, the same routes the desktop and web clients use.
Package search is the note-search scoring the app's search palette uses: exact and prefix matches first, then word starts, then substrings, then a fuzzy subsequence for short queries; `#tag` tokens narrow the set.
Package search is the note-search scoring the app's search palette uses: exact and prefix matches first, then word starts, then substrings, then a fuzzy subsequence for short queries; `#tag` tokens narrow the set.
Package templates is the note-template system: the built-ins the app ships, custom templates parsed from `.zennotes/templates/*.md`, and the `{{variable}}` substitution applied when a note is created from one.
Package templates is the note-template system: the built-ins the app ships, custom templates parsed from `.zennotes/templates/*.md`, and the `{{variable}}` substitution applied when a note is created from one.
Package themes ports the desktop app's color schemes to the terminal: the registry of built-in themes, the --z-* tokens each one defines, and the custom themes users drop under <config>/themes.
Package themes ports the desktop app's color schemes to the terminal: the registry of built-in themes, the --z-* tokens each one defines, and the custom themes users drop under <config>/themes.
gen command
Command gen rebuilds internal/themes/builtin.css from the desktop app's stylesheet.
Command gen rebuilds internal/themes/builtin.css from the desktop app's stylesheet.
Package vault is the filesystem engine behind every zn command and the terminal UI: it reads and writes a ZenNotes vault exactly the way the desktop app, the bundled `zn`, and the self-hosted server do.
Package vault is the filesystem engine behind every zn command and the terminal UI: it reads and writes a ZenNotes vault exactly the way the desktop app, the bundled `zn`, and the self-hosted server do.
Package vim is a Vim editing engine over a plain text buffer: modes, counts, registers, motions, operators, text objects, visual selections, undo, dot-repeat, macros, marks, search and substitute, an ex command line, and heading folds.
Package vim is a Vim editing engine over a plain text buffer: modes, counts, registers, motions, operators, text objects, visual selections, undo, dot-repeat, macros, marks, search and substitute, an ex command line, and heading folds.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL