Skip to main content

License: MIT Tests Publish Python package to PyPI

Русский

terminal-note

A console utility for creating and managing notes without leaving the terminal.

Contents

Motivation

I mostly work in the terminal and use tools like nvim, rg, fd, and fzf. For note-taking, I use Obsidian — it stores notes locally in separate .md files, which is very convenient. However, launching Obsidian takes time, and constantly switching between the terminal and a GUI application disrupts my workflow.

To stay inside the terminal, I wrote terminal-note — a utility that allows you to quickly create, search, and manage notes directly from the console.

Features

  • Create notes with one command without opening an editor.
  • Search, open, delete, and read notes using fzf.
  • Notes are saved in Markdown (.md) format.
  • Support for templates and flexible configuration through a config file.
  • Works with a chosen directory — easily integrates with Obsidian.
  • Write notes in your favorite console editor: nvim, micro, and others.

Installation

  1. Install via pip:
pip install terminal-note --user
  1. Verify it works:
tn --help

Usage

  • tn --config or tn -c — open the configuration file.
  • tn "note text" — create a quick note. The file will be named by a template (2025-04-05 15:30:00.md) and saved in the specified directory.
  • tn -o — create or open a note. First, enter the file name, then the editor opens. If the file exists — it is edited; if not — created.
  • tn -d — delete a note. The file is selected for deletion via fzf.
  • tn -r — read a note. The file is selected through fzf and opened in frogmouth (which parses Markdown with navigation support).

Demo

Displaying help

Вызов справки

Editing the config file

Конфиг файл

Inline note creation

inline note

Editing a note

edit

Creating a new note

new note

Deleting a note

delete note

Reading a note

read

Dependencies

  • python >= 3.11
  • iterfzf >= 1.8.0.62.0
  • frogmouth >= 0.9.2

Configuration file

# Storage mode (files only)
storage_mode = "files"

# Path to the directory where notes will be stored.
# The script parses only the $HOME variable. If a special path is needed, specify it fully.
path_to_storage_directory = "$HOME/terminal_note"

# File extension for notes: txt, md (without the dot .md)
file_extension = "md"

# Utility for reading non-md files: bat, cat, less
file_reader = "cat"

# Path to the template file.
path_to_template_note = "$HOME/terminal_note/Templates/template.md"

# Editor to write notes comfortably: vi, vim, nvim, micro, nano, etc.
editor = "vi"

Storage structure

Example storage structure:

➜  ~ tree terminal_note
$HOME/terminal_note/
├── 2025-07-22 22:32:26.md
├── 2025-07-22 22:34:56.md
├── 2025-07-27 00:41:52.md
├── Gurtam
│   ├── 1. Vialon.md
│   ├── 2. Token authentication.md
│   └── 3. Searching elements.md
├── My Book.md
└── Templates
    └── template.md

3 directories, 8 files

Example template (template.md)

---
Creation date:
Modification date:
links:
tags:
---

Ideas

  • Git integration: tn -g will perform pull, add, commit, push.
  • Support storage in a database (not sure yet — as it breaks compatibility with Obsidian).
  • Possibly store inline quick notes in a separate directory for easier searching.

Metadata

Release files for terminal-note 0.10.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for terminal-note 0.10.0
File Size Uploaded Provenance Actions
terminal_note-0.10.0.tar.gz 11.7 kB With provenance Details for terminal_note-0.10.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for terminal-note 0.10.0
File Interpreter ABI Platform Actions
terminal_note-0.10.0-py3-none-any.whl Python 3 none any Details for terminal_note-0.10.0-py3-none-any.whl

Total release size: 23.1 kB

Release files / terminal_note-0.10.0.tar.gz

Download URL terminal_note-0.10.0.tar.gz
Size 11.7 kB
Tags Source
SHA-256 checksum
How to use checksums
3556760d6ce7846c9cd247abd486afa8d48dff43c9e997a915cd5bd314b6c5c5
BLAKE2b-256 checksum
How to use checksums
5bd37835da215483c6b6d134395d5f9166747ede5deeb300e9c990bf3ded79bb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Aug 21, 2025.

Transparency log

Release files / terminal_note-0.10.0-py3-none-any.whl

Download URL terminal_note-0.10.0-py3-none-any.whl
Size 11.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1245680d75ad78a0645cb121405d27a39ebe45e6e7c92aa5d64ef4646574d4e3
BLAKE2b-256 checksum
How to use checksums
3935b45d2f86bd4470da84914187137e5d149266e85888a356949bad6023f2f1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Aug 21, 2025.

Transparency log

Security for terminal-note 0.10.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for terminal_note-0.10.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Aug 21, 2025.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page