Skip to content

README.md

Latest commit

 

History

History
55 lines (36 loc) · 1.78 KB

README.md

File metadata and controls

55 lines (36 loc) · 1.78 KB

nnote

PyPI downloads Github commits (since latest release)

Packaging status

A minimal CLI note-taking tool. Notes are plain files stored in a directory of your choice.

Installation

Arch Linux (AUR)

yay -S nnote

Or with any other AUR helper, or manually via makepkg.

From source

pip install -e .

Setup

nnote init

Prompts for a notes directory (default: ~/nnotes) and a default editor. Config is saved to ~/.config/nnote/config.yaml. If $EDITOR is set in your environment, it will be used as the editor default.

Documentation

Full documentation is published at https://stiermid.github.io/nnote/.

Command reference (also browsable in this repo):

  • new — create a note (or a subdirectory)
  • view — print a note to stdout
  • edit — open an existing note in the editor
  • list — display notes as a tree
  • drop — remove a note or directory
  • move — rename or relocate a note
  • backup — export notes to a .tar.gz archive
  • search — search notes by title and content

Config file format: docs/configuration.rst.

License

This project is licensed under the GNU General Public License v3.0 or later. See LICENSE for details.