54 lines
1.6 KiB
Markdown
54 lines
1.6 KiB
Markdown
# halig
|
|
|
|
|
|
|
|
|
|
[](https://pdm.fming.dev)
|
|
|
|
[(R)age](https://github.com/woodruffw/pyrage) 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](https://github.com/FiloSottile/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
|
|
|
|
```shell
|
|
pipx install halig # or pip
|
|
```
|
|
|
|
## Setup TLDR
|
|
|
|
```shell
|
|
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
|
|
|
|
```shell
|
|
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
|
|
```
|
|
|