KBSecret

KBSecret is a command line utility and library for managing secrets.

Quick links:

Hacking on KBSecret

Want to hack on KBSecret? Here's how you can get started:

$ git clone [email protected]:kbsecret/kbsecret.git && cd kbsecret
$ bundle install --path vendor/bundle
$ RUBYLIB=./lib PATH=./bin:${PATH} bundle exec ./bin/kbsecret help

System Packages

You can also build (very experimental) installation packages:

$ bundle exec make deb # for apt/dpkg based systems
$ bundle exec make rpm # for yum/rpm based systems
$ bundle exec make pacman # for pacman based systems
$ ls pkg/{deb,rpm,pacman}/*

Manual Pages

KBSecret's manual pages can be found online here.

If you'd like to generate the roff versions for man(1), you'll need ronn(1):

$ bundle exec make man
$ cp man/*.1 ${YOUR_MAN_DIR}

Shell Completion

KBSecret provides shell completion functions for bash.

To generate them:

$ bundle exec make bash
$ # or, if you have additional commands that support --introspect-flags:
$ CMDS='foo bar baz' bundle exec make bash
$ cp completions/kbsecret.bash ${YOUR_COMPLETION_DIR}

Please feel free to contribute completion scripts for other shells!

Contributing

See "help wanted" on the issue tracker.

If you have an idea for a new feature, please suggest it! Pull requests are also welcome.

Community and Help

If you'd like help or would just like to chat about KBSecret's development, please join us in #kbsecret on Freenode.

Licensing

KBSecret is licensed under the MIT License.

KBSecret's logo was created by Arathnim.