== Kanako (神奈子)
The infinitely adaptable password manager, written in Bourne Shell.\\
Named after one of the deities of the [https://en.touhouwiki.net/wiki/Moriya_Shrine Moriya Shrine], [https://en.touhouwiki.net/wiki/Kanako_Yasaka Kanako Yasaka], from [https://en.touhouwiki.net/wiki/Mountain_of_Faith Mountain of Faith]

=== Supported back-ends
* [https://age-encryption.org age]
* [https://z3bra.org/cream/ cream]
* [https://gnupg.org gpg]
* [https://git.mills.io/prologic/salty salty]

=== Setting it up
1. Copy [https://svn.yakumo.dev/repo/kanako/trunk/kanako.conf.example kanako.conf.example] to `~/.config/kanako/kanako.conf` and edit accordingly, there are all sorts of examples for each backend supported.
2. Create `~/.kanako` and `~/.kanako-store` with `mkdir -p`, the former stores your key pair, the latter your password store.

=== Using the password store

==== Listing all existing entries

{{{
#!sh
$ kanako -l

/home/user/.kanako-store/
|--- Git
|    |--- github.com
           |--- password
           |--- username
[...]
}}}

==== Copying entries to the clipboard
You need to uncomment the proper field (only `xclip` is supported)

{{{
#!sh 
$ kanako -c Git/github.com/password
}}}

==== Adding entries to the store
You have to set {{{ $EDITOR }}}, if unset, the default is {{{ vi }}}, which may or may not be available on your system.

{{{
#!sh
$ kanako -n Social/misskey.io/password
}}}

==== Removing entries from the store
You can remove them one at a time, with `-r`, or recursively, with `-R`, the program will ask you
for confirmation either way.

==== Using one-time passwords (OTP)
Insert the OTP key on a line of its own as `totp: <private key>`, wherever you store the password, and obtain a PIN calling the program with the `-o` switch as opposed to `-v`

=== Extensions
* [https://svn.yakumo.dev/repo/kanako/trunk/addons/kanako-menu kanako-menu] - quick graphical front-end, requires [http://tools.suckless.org/dmenu/ dmenu], but can also use [https://github.com/Cloudef/bemenu bemenu] instead.

=== Documentation
See the man pages: `kanako(1)`, `kanako.conf(5)`

=== Credit & License
`kanako` was written by [https://mugen-no-ryouiki.yakumo.dev Izuru Yakumo] of [https://yakumo.dev Yakumo Laboratories].

This program and the extensions are licensed under the [https://git.yakumo.dev/yakumo.izuru/kanako/src/branch/master/COPYING Beerware License (Revision 42.1) -- based on Poul-Henning Kamp's license]

{{{
/*
 * ----------------------------------------------------------------------------
 * "THE BEER-WARE LICENSE" (Revision 42.1):
 * <eternal-servant@yakumo.dev> wrote this file. As long as you retain this notice you
 * can do whatever you want with this stuff. If we meet some day, and you think
 * this stuff is worth it, you can buy me a bottle of sake in return Izuru Yakumo
 * ----------------------------------------------------------------------------
 */
}}}