== 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://git.chaotic.ninja/yakumo.izuru/kanako/raw/branch/master/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

{{{
$ kanako -l

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

==== Copying entries to the clipboard
You need to uncomment the proper fields to use either `xclip` or `wl-copy`.\
Note: Complete support for Wayland is not a goal (and in fact, it's inviable)

{{{ 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.

{{{
$ kanako -n Social/misskey.io/password
<editor screen omitted for brevity>
}}}

==== Removing entries from the store
You can remove them one at a time, with `-r`, or recursively, with `-R`.\\
Both ways require that `rm` supports the `-i` and `-I` flags, respectively.

=== Download
* [https://git.chaotic.ninja/yakumo.izuru/kanako/archive/master.tar.gz Latest master]

=== Git repository
You can [https://git.chaotic.ninja/yakumo.izuru/kanako browse the git repository] or clone it:

{{{
$ git clone https://git.chaotic.ninja/yakumo.izuru/kanako
}}}

=== Extensions
* [https://git.chaotic.ninja/yakumo.izuru/kanako/src/branch/master/addons/kanako-menu kanako-menu] - quick graphical front-end, requires `dmen
u`, but can also use `bmenu` instead.
* [https://git.chaotic.ninja/yakumo.izuru/kanako/src/branch/master/addons/kanako-totp kanako-totp] - time-based one time password addon, based on [https://rgz.ee rgz.ee]'s code, requires `oathtool` from oath-toolkit.

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

=== Credit & License
`kanako` was written by [https://interconnected.chaotic.ninja Izuru Yakumo] of Yakumo Laboratories.

This program and the extensions are licensed under the [https://git.chaotic.ninja/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):
 * <yakumo.izuru@chaotic.ninja> 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
 * ----------------------------------------------------------------------------
 */
}}}