kbsecret 0.9.0.pre.2 → 0.9.0.pre.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +19 -68
  3. data/lib/version.rb +1 -1
  4. metadata +3 -3
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 0ff44117e13068cc632bb962c71ea5e5d9ad238e
4
- data.tar.gz: c430ab80d215feecf41156280f87e4ac225e96bf
3
+ metadata.gz: e3e48fed3c7adcab87abbce97d3fe3cf7b5f56ed
4
+ data.tar.gz: 2cd6cb7f5da242bdd4f3460f125fe5210f836108
5
5
  SHA512:
6
- metadata.gz: 68bc5d924a7d9696f7dc00e9034d6039900a9d0f262e26f3b4a34e2239c856171a71c5b125cd2868f9596ac244660571b9918a271a67157b6e4dee5466f4be8c
7
- data.tar.gz: fe32495433a56fbeec977707ee699cfd94b6bcf854083e0a1621fa2c8a71df5bb98c3c02e825dbedb21418a5e3b3d228da3645db85b1be5251a78259400cdd4d
6
+ metadata.gz: ca11e0f0d9d842ea042cba89d4d2cb7d88827a3ecdae4334efdce498879716afadc238c0731d5e6c1c349e2e080abc5e582fbd741acc6e35c02d151795fab0b5
7
+ data.tar.gz: aaaf97b96f65b6e491c608e168866892942942c293c83c0d617833f032bbd264d3e097ec99daf437d2217b6eceeb0ec96246e7f6cacd7274df6c79bb21226803
data/README.md CHANGED
@@ -1,38 +1,23 @@
1
- KBSecret
1
+ KBSecret ![](https://kbsecret.github.io/res/logo50.png)
2
2
  ========
3
3
 
4
4
  [![Gem Version](https://badge.fury.io/rb/kbsecret.svg)](https://badge.fury.io/rb/kbsecret)
5
5
  [![Build Status](https://travis-ci.org/kbsecret/kbsecret.svg?branch=master)](https://travis-ci.org/kbsecret/kbsecret)
6
- [![Coverage Status](https://coveralls.io/repos/github/kbsecret/kbsecret/badge.svg?branch=coveralls)](https://coveralls.io/github/kbsecret/kbsecret?branch=coveralls)
6
+ [![Coverage Status](https://coveralls.io/repos/github/kbsecret/kbsecret/badge.svg)](https://coveralls.io/github/kbsecret/kbsecret?branch=coveralls)
7
7
 
8
- *Note*: This is still a work in process. Use it with caution.
8
+ KBSecret is a command line utility and library for managing *secrets*.
9
9
 
10
- KBSecret is a combined library/utility that provides a secret management
11
- interface for [KBFS](https://keybase.io/docs/kbfs) and
12
- [Keybase](https://keybase.io/).
10
+ Quick links:
13
11
 
14
- ### Benefits over current offerings
12
+ * [Installation instructions](https://kbsecret.github.io/installation)
13
+ * [Quick start guide](https://kbsecret.github.io/quickstart)
14
+ * [CLI documentation](https://kbsecret.github.io/man/)
15
+ * [API documentation](http://www.rubydoc.info/gems/kbsecret/)
16
+ * [Customizing your installation](https://kbsecret.github.io/customization)
15
17
 
16
- * Easy password and environment sharing across multiple users.
17
- - `kbsecret login -s dev-team github` prints the dev team's GitHub login.
18
- * No PGP/SSH key setup necessary - you only need a Keybase account.
19
- - No more worrying about losing your key.
20
- * Transparent access - KBFS provides a VFS layer over all reads/writes.
21
- - All records are stored encrypted on KBFS.
18
+ ## Hacking on KBSecret
22
19
 
23
- ### Installation
24
-
25
- KBSecret is available via [RubyGems](https://rubygems.org/gems/kbsecret):
26
-
27
- ```bash
28
- $ gem install kbsecret
29
-
30
- # or, install the latest prerelease:
31
-
32
- $ gem install --pre kbsecret
33
- ```
34
-
35
- For hacking:
20
+ Want to hack on KBSecret? Here's how you can get started:
36
21
 
37
22
  ```bash
38
23
  $ git clone git@github.com:kbsecret/kbsecret.git && cd kbsecret
@@ -40,6 +25,8 @@ $ bundle install --path vendor/bundle
40
25
  $ RUBYLIB=./lib PATH=./bin:${PATH} bundle exec ./bin/kbsecret help
41
26
  ```
42
27
 
28
+ ### System Packages
29
+
43
30
  You can also build (very experimental) installation packages:
44
31
 
45
32
  ```bash
@@ -49,48 +36,6 @@ $ bundle exec make pacman # for pacman based systems
49
36
  $ ls pkg/{deb,rpm,pacman}/*
50
37
  ```
51
38
 
52
- Documentation is available on [RubyDoc](http://www.rubydoc.info/gems/kbsecret/).
53
-
54
- ### Usage
55
-
56
- ```bash
57
- # create a new login record under the default session
58
- $ kbsecret new login gmail
59
- Username? bob@gmail.com
60
- Password?
61
-
62
- # list all records under the default session
63
- $ kbsecret list
64
- gmail
65
-
66
- # show the requested login record
67
- $ kbsecret login gmail
68
- Label: gmail
69
- Username: bob@gmail.com
70
- Password: barbazquux
71
-
72
- # create a new session between 3 keybase users (foo, bar, and baz)
73
- $ kbsecret new-session -l dev-team -u foo,bar,baz
74
-
75
- # list available sessions
76
- $ kbsecret sessions
77
- default
78
- dev-team
79
-
80
- # add an environment record to the dev-team session
81
- $ kbsecret new environment api-key -s dev-team
82
- Variable? BRAND_NEW_API
83
- Value?
84
-
85
- # list all records under the dev-team session
86
- $ kbsecret list -s dev-team
87
- api-key
88
-
89
- # get all environment records in dev-team in an easy-to-source format
90
- $ kbsecret env -s dev-team --all
91
- export BRAND_NEW_API='0xBADBEEF'
92
- ```
93
-
94
39
  ### Manual Pages
95
40
 
96
41
  KBSecret's manual pages can be found online
@@ -129,3 +74,9 @@ If you have an idea for a new feature, please suggest it! Pull requests are also
129
74
 
130
75
  If you'd like help or would just like to chat about KBSecret's development, please
131
76
  join us in `#kbsecret` on Freenode.
77
+
78
+ ## Licensing
79
+
80
+ KBSecret is licensed under the MIT License.
81
+
82
+ KBSecret's logo was created by [Dylan Ball](https://github.com/arathnim).
data/lib/version.rb CHANGED
@@ -2,5 +2,5 @@
2
2
 
3
3
  module KBSecret
4
4
  # kbsecret's current version
5
- VERSION = "0.9.0.pre.2"
5
+ VERSION = "0.9.0.pre.3"
6
6
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: kbsecret
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.9.0.pre.2
4
+ version: 0.9.0.pre.3
5
5
  platform: ruby
6
6
  authors:
7
7
  - William Woodruff
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2017-08-15 00:00:00.000000000 Z
11
+ date: 2017-08-17 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: fpm
@@ -232,7 +232,7 @@ files:
232
232
  - lib/kbsecret/record/unstructured.rb
233
233
  - lib/kbsecret/session.rb
234
234
  - lib/version.rb
235
- homepage: https://github.com/kbsecret/kbsecret
235
+ homepage: https://kbsecret.github.io
236
236
  licenses:
237
237
  - MIT
238
238
  metadata: {}