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

Uploaded Source

Built Distribution

halig-0.6.0-py3-none-any.whl (28.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: halig-0.6.0.tar.gz
  • Upload date:
  • Size: 29.5 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.0.tar.gz
Algorithm Hash digest
SHA256 5f91c9718a9af31c47dabcde575f23c7ee53caf6717d6c6824ddc0d3dd696639
MD5 a2095944fe5ba08f179ddf5df075be4f
BLAKE2b-256 6ce91e3bf3a9b57689e1be83646341d9577c7a364ad361365da41468b22a5c86

See more details on using hashes here.

File details

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

File metadata

  • Download URL: halig-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 28.3 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9d3e723080ee10e3f3bdb5d4632e32b0ae4e6c17c89eb64830fa2bcfcc8600e2
MD5 ab73879805271622ac8f768b2dac597e
BLAKE2b-256 e75e27ed1128b6bdafcce7d7c9a32ffa840123df831422f499c8adf32ae6f7a2

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