about summary refs log blame commit diff stats
path: root/README
blob: 01b770285aa40593478478fd898fd617c406c7b1 (plain) (tree)
1
2
3
4
5
6
7
8
9
10
            

   
                                                                                          
                                                                                                 




                                                                                 
                                                                                                               
 
                                                                                             
 
                                            






                                        
                                                         

                                          
 






                                                      





                         









                                            


       
                         
ayu (あゆ)
===

Not-so standard unix password manager, written in (mostly) posix shell (69 SLoC,  63 ULoC)
Uses <https://age-encryption.org> as back-end, and tree(1) to list contents of the password store

Caveats
-------

For the utility to work, you have to generate your own keypair with age-keygen(1)
The private key should be placed as ~/.ayu/private_key and the public key should be placed as ~/.ayu/public_key

e.g. age-keygen -o ~/.ayu/private_key && age-keygen -y ~/.ayu/private_key > ~/.ayu/public_key

Store is located by default on ~/.ayu-store/

Anti-features
-------------

1) built-in integration with Git
2) built-in automatic keypair generation

Neither of those are included and probably will never be.
Just use the CLI tools by themselves, lol.


Add-ons
-------

1) ayu-bemenu: bemenu integration
2) ayu-dmenu: same as above but dmenu
3) ayu-totp: adds time-based one-time password support

Dependencies
-------------

1) age(1), duh!
2) mandoc (documentation)
3) tree

Related software
----------------

[angou]: <https://gt.kalli.st/shokara/angou>
[pa]: <https://github.com/biox/pa>
[page]: <https://github.com/e-zk/page>
[pass]: <https://passwordstore.org>


License
-------

Discordian Public License