Noter

Localzet Group

Noter

English Русский

Noter is a command-line client that sends a note to an HTTP(S) receiver configured by the operator.

Install

Download and review the installer before running it with elevated privileges:

curl -fsSLo /tmp/noter-install.sh --proto '=https' --tlsv1.2 https://raw.githubusercontent.com/localzet/Noter/main/install.sh
less /tmp/noter-install.sh
sudo bash /tmp/noter-install.sh -u "https://notes.example.com/api/notes"

The installer prompts for the API key without echoing it and writes the configuration under /usr/local/noter/. The -k option is available, but command-line arguments can be recorded in shell history or process listings.

Use

noter "A note from the terminal"
printf '%s' "A note from standard input" | noter

On success, Noter prints the HTTP status without displaying the receiver’s response body. Response bodies are discarded and limited to 8 KiB; network failures, oversized responses, and non-2xx HTTP responses return a failure exit code.

Configuration

The installer creates /usr/local/noter/noter.zconf:

NOTER_URL = "https://notes.example.com/api/notes"
NOTER_KEY = "replace-with-your-api-key"

Noter also checks for noter.zconf next to the executable. Protect the file so only the account running Noter can read it.

Noter sends an HTTP POST request with Content-Type: application/json, an X-API-KEY header and a JSON content field. Remote URLs must use HTTPS. Plain HTTP is accepted only for loopback IP addresses such as 127.0.0.1 and ::1.

Noter sends note text unchanged in the JSON content field. The receiving application is responsible for context-appropriate output encoding; HTML-escape the value when rendering it in a page and never insert untrusted note content as raw HTML.

Noter is a client: it does not host the receiving API, store notes, or define the receiver’s authorization and retention policy.

Development

See contribution guidelines and the security policy. PhpStorm uses the repository’s .editorconfig; Visual Studio Code settings and tasks are in .vscode/.

Copyright © 2016-2026 Localzet Group. All rights reserved.