---
title: "Documentation · tnotes"
description: "tnotes documentation: install, keyboard and mouse reference, config.toml, the JSON CLI, and sync/encryption recipes."
canonical: https://tnotes.app/docs
---

# \# Documentation

Everything in the README, split by topic. The in-app ? page is always the source of truth for keys.

-   [Getting startedInstall tnotes with Homebrew, cargo or a prebuilt tarball, open your first notes folder, and learn the layout of the terminal UI.](/docs/getting-started)
-   [Keyboard and mouseEvery tnotes keybinding for the list, tree and editor, in emacs and vim modes, plus mouse actions.](/docs/keys)
-   [ConfigurationEvery key in tnotes' config.toml with its default — roots, appearance, editor (emacs/vim, autosave, wrap, width) and theme colours.](/docs/config)
-   [CLI referenceThe headless tnotes commands — ls, search, cat, new, append, write, trash, restore — with --json output, filters, stdin input and note ids.](/docs/cli)
-   [Sync and encryptionSync tnotes with Syncthing, iCloud Drive, Dropbox or git and encrypt the vault with FileVault, gocryptfs or fscrypt — how conflicts and atomic saves keep notes safe.](/docs/sync)
-   [Use with AI agentsRecipes for Claude Code, Codex, cron jobs and shell scripts that read and write the vault through the CLI.](/agents)