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.6.1.tar.gz (29.7 kB view details)

Uploaded Source

Built Distribution

halig-0.6.1-py3-none-any.whl (28.7 kB view details)

Uploaded Python 3

File details

Details for the file halig-0.6.1.tar.gz.

File metadata

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

File hashes

Hashes for halig-0.6.1.tar.gz
Algorithm Hash digest
SHA256 dba1071fc1e74b88a4ab8a7aa6cced8679eae75dd47ec56b2f36a6abcc54b403
MD5 f7d44b3e1013a382d9a2c27e6d99b16f
BLAKE2b-256 e0e32416cecd14b440f75436cd48fa4d357729eeae0cb9dce398a6371e281cea

See more details on using hashes here.

File details

Details for the file halig-0.6.1-py3-none-any.whl.

File metadata

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

File hashes

Hashes for halig-0.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 07f2660fa8c62489bf03b5eec0d2142978c79342f8848c8a1c33ab5907395437
MD5 09b76187a35a99a23296c0aa36fa23ed
BLAKE2b-256 5b5cf90b8b90f05b5001131bb24a1031bcebf81d7ef5031706437cfe9619607b

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