Skip to main content

age-encrypted, file-based, note-taking CLI app

Project description

halig

Build status PyPI PyPI - License PyPI - Python Version pdm-managed

(R)age encrypted note-taking CLI app.

halig opens, using your favorite $EDITOR, an in-memory copy of a file and upon save-and-exit, it encrypts the new contents into an age file that you can store, relatively safe, anywhere.

Features

  • Simple notebooks management with paths autocompletion
  • Passphrase-less, fully-encrypted notes, compatible with existing SSH keys
  • No external age binary needed
  • Almost all age advantages, like having multiple keys for encryption and decryption
  • Remote (HTTP) public keys import: e.g: github.com/<username>.keys

Install

pipx install halig # or pip

Setup TLDR

set -e
ssh-keygen -t ed25519
mkdir -p "${XDG_CONFIG_HOME:-$HOME/.config}/halig"
cat << EOF > "${XDG_CONFIG_HOME:-$HOME/.config}/halig/halig.yml"
---
notebooks_root_path: ~/Documents/Notebooks
identity_paths:
  - ~/.ssh/id_ed25519
recipient_paths:
  - ~/.ssh/id_ed25519.pub
  - https://github.com/<username>.keys
  - https://gitlab.com/<username>.keys
EOF

Usage TLDR

halig edit some_notebook     # edit today's note relative to <notebooks_root_path>/some_notebook
halig edit some_notebook/foo # edit  <notebooks_root_path>/some_notebook/foo.age
halig notebooks              # list current notebooks
halig git commit
halig git push

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

halig-0.5.1a2.tar.gz (28.9 kB view details)

Uploaded Source

Built Distribution

halig-0.5.1a2-py3-none-any.whl (27.7 kB view details)

Uploaded Python 3

File details

Details for the file halig-0.5.1a2.tar.gz.

File metadata

  • Download URL: halig-0.5.1a2.tar.gz
  • Upload date:
  • Size: 28.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: pdm/2.18.1 CPython/3.12.5 Linux/6.10.7-zen1-1-zen

File hashes

Hashes for halig-0.5.1a2.tar.gz
Algorithm Hash digest
SHA256 b4edda1a0e81156b7b0399f546e900f662dc0a37855f5d8d34ac06b8e871a4d1
MD5 3d0481e6c223d5f1cf695724259194d9
BLAKE2b-256 4463e43ec2573fd9be0b412472d6d9ffdfabe473ee127204b8435cb6b52515ce

See more details on using hashes here.

File details

Details for the file halig-0.5.1a2-py3-none-any.whl.

File metadata

  • Download URL: halig-0.5.1a2-py3-none-any.whl
  • Upload date:
  • Size: 27.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: pdm/2.18.1 CPython/3.12.5 Linux/6.10.7-zen1-1-zen

File hashes

Hashes for halig-0.5.1a2-py3-none-any.whl
Algorithm Hash digest
SHA256 f2fceacccb6a00ca2302ba0c9454bbbf1a02cd07826ffa9398fea72543f8c09a
MD5 89f9085427e005fb9b3d35ae0ed55253
BLAKE2b-256 f2ba9907a7550219562efedd05b727e653b68b09079e171569b1dcfa0ddd435b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page