forked from mkideal/onepw
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
b419776
commit b72e54b
Showing
6 changed files
with
335 additions
and
322 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,15 +1,14 @@ | ||
# onepw [![License](http://img.shields.io/badge/license-mit-blue.svg?style=flat-square)](https://raw.githubusercontent.com/mkideal/onepw/master/LICENSE) [![Go Report Card](https://goreportcard.com/badge/github.com/mkideal/onepw)](https://goreportcard.com/report/github.com/mkideal/onepw) | ||
## onepw [![License](http://img.shields.io/badge/license-mit-blue.svg?style=flat-square)](https://raw.githubusercontent.com/mkideal/onepw/master/LICENSE) [![Go Report Card](https://goreportcard.com/badge/github.com/mkideal/onepw)](https://goreportcard.com/report/github.com/mkideal/onepw) | ||
|
||
## Install | ||
### Install | ||
|
||
```sh | ||
go get github.com/mkideal/onepw | ||
``` | ||
check [Releases](https://github.com/cloud-org/onepw/releases) | ||
|
||
### What's this | ||
|
||
## What's this | ||
onepw is a command line tool for managing passwords, provides `init`,`add`,`remove`,`list`,`find`,`generate`,`info` commands. You **MUST** remember the `master password`, and don't tell anyone! | ||
onepw is a command line tool for managing passwords. You **MUST** remember the `master password`, and don't tell anyone! | ||
|
||
## Principles | ||
### Principles | ||
|
||
1. Generate Key by master password | ||
|
||
|
@@ -37,317 +36,10 @@ o-----------o | AES Cipher | | | |
o-----------o | ||
``` | ||
|
||
## Commands | ||
|
||
* help - `display help` | ||
* version - `display version` | ||
* init - `init password box or modify master password` | ||
* add - `add a new password or update old password` | ||
* remove - `remove passwords by ids or (category,account)(aliases rm,del,delete)` | ||
* list - `list all passwords(aliases ls)` | ||
* find - `find password by id,category,account,tag,site and so on` | ||
* upgrade - `upgrade to newest version(aliases up)` | ||
* generate - `a utility command for generating password(aliases gen)` | ||
* info - `show low level information of password` | ||
|
||
### help - `show help information` | ||
|
||
```sh | ||
# show help information of onepw | ||
$> onepw | ||
# or | ||
$> onepw help | ||
|
||
# show help information of specific command | ||
$> onepw help COMMAND | ||
# or | ||
$> onepw COMMAND -h | ||
``` | ||
|
||
### version - `show onepw version` | ||
|
||
```sh | ||
$> onepw version | ||
# or | ||
$> onepw -v | ||
``` | ||
|
||
### init - `init password box` | ||
First of all, you should `init` a password box with master password. | ||
|
||
```sh | ||
# Will prompt for enter master password | ||
$> onepw init | ||
type the master password: | ||
``` | ||
|
||
**NOTE**: The master password can be set by ENV variable ONEPW_MASTER. | ||
|
||
### add - `add a new command or update old password` | ||
|
||
```sh | ||
Options: | ||
|
||
-h, --help | ||
display help information | ||
|
||
--master[=$ONEPW_MASTER] | ||
master password | ||
|
||
--debug[=false] | ||
usage debug mode | ||
|
||
-c, --category | ||
category of password | ||
|
||
-u, --account | ||
account of password | ||
|
||
--site | ||
website of password | ||
|
||
--tag | ||
tags of password | ||
|
||
--id | ||
password id for updating | ||
|
||
--pw, --password | ||
the password | ||
|
||
--cpw, --confirm-password | ||
confirm password | ||
``` | ||
|
||
```sh | ||
$> onepw add -c=email -u [email protected] | ||
type the password: | ||
repeat the password: | ||
``` | ||
|
||
### list - `list all passwords, aliases ls` | ||
|
||
```sh | ||
Options: | ||
|
||
-h, --help | ||
display help information | ||
|
||
--master[=$ONEPW_MASTER] | ||
master password | ||
|
||
--debug[=false] | ||
usage debug mode | ||
|
||
--no-header[=false] | ||
don't print header line | ||
``` | ||
```sh | ||
$> onepw list | ||
# or | ||
$> onepw ls | ||
``` | ||
### remove - `remove passwords by ids or account, aliases rm/del/delete` | ||
```sh | ||
Usage: onepw rm [ids...] [OPTIONS] | ||
Options: | ||
-h, --help | ||
display help information | ||
--master[=$ONEPW_MASTER] | ||
master password | ||
--debug[=false] | ||
usage debug mode | ||
-a, --all[=false] | ||
remove all found passwords | ||
``` | ||
### find - `find passwords by id,category,account,...` | ||
```sh | ||
Usage: onepw find <WORD> | ||
Options: | ||
-h, --help | ||
display help information | ||
--master[=$ONEPW_MASTER] | ||
master password | ||
--debug[=false] | ||
usage debug mode | ||
-p, --just-password[=false] | ||
only show password | ||
-f, --just-first[=false] | ||
only show first result | ||
``` | ||
### generate - `generate password, aliases gen` | ||
```sh | ||
Usage: onepw gen [OPTIONS] LEN | ||
Options: | ||
-h, --help | ||
display help information | ||
-n, --number=N[=1] | ||
number of generated passwords | ||
-d, --digit[=false] | ||
whether the password contains digit | ||
-c, --lower-char[=false] | ||
whether the password contains lowercase character | ||
-C, --upper-char[=false] | ||
whether the password contains uppercase character | ||
-s, --special-char[=false] | ||
whether the password contains the special character | ||
--sset, --special-set | ||
custom special character set | ||
``` | ||
```sh | ||
$> onepw gen 12 | ||
FA7vAeZML02r | ||
$> onepw gen 12 -cs | ||
iqva%kj*^!!f | ||
$> onepw gen 16 -cCdS | ||
0g1b^TgAUXAij2KC | ||
``` | ||
### info - `show low-level information of password` | ||
### Get Started | ||
|
||
```sh | ||
Usage: onepw info <ids...> | ||
Options: | ||
-h, --help | ||
display help information | ||
--master[=$ONEPW_MASTER] | ||
master password | ||
--debug[=false] | ||
usage debug mode | ||
-a, --all | ||
show all found passwords | ||
``` | ||
## Example | ||
```sh | ||
$> echo "export ONEPW_FILE=~/mypasswords/password.data" | ||
$> echo "export ONEPW_MASTER=MySecret" | ||
# init password box | ||
$> onepw init | ||
# add a new password | ||
$> onepw add -c email -u [email protected] | ||
type the password: | ||
repeat the password: | ||
password d9437f07af7c8b035a4fa9513ace449f added | ||
# list all passwords | ||
$> onepw ls | ||
+---------+----------+------------------+----------+---------------------------+ | ||
| ID | CATEGORY | ACCOUNT | PASSWORD | UPDATED_AT | | ||
+---------+----------+------------------+----------+---------------------------+ | ||
| d9437f0 | email | [email protected] | 123456 | 2016-04-29T00:54:36+08:00 | | ||
+---------+----------+------------------+----------+---------------------------+ | ||
# add a new password | ||
$> onepw add -c github -u hello --pw=123456 --cpw=123456 | ||
password 3439d3178f35f56f4c3d6f27e7ccc9a7 added | ||
# list all passwords | ||
$> onepw ls | ||
+---------+----------+------------------+----------+---------------------------+ | ||
| ID | CATEGORY | ACCOUNT | PASSWORD | UPDATED_AT | | ||
+---------+----------+------------------+----------+---------------------------+ | ||
| 3439d31 | github | hello | 123456 | 2016-04-29T00:56:26+08:00 | | ||
+---------+----------+------------------+----------+---------------------------+ | ||
| d9437f0 | email | [email protected] | 123456 | 2016-04-29T00:54:36+08:00 | | ||
+---------+----------+------------------+----------+---------------------------+ | ||
# add a new password | ||
$> onepw add -c email -u [email protected] --site=gmail.com --tag=google | ||
type the password: | ||
repeat the password: | ||
password 2ca000f993a665337bebd4700cfd7c6c added | ||
# list all passwords | ||
$> onepw ls | ||
+---------+----------+------------------+----------+---------------------------+ | ||
| ID | CATEGORY | ACCOUNT | PASSWORD | UPDATED_AT | | ||
+---------+----------+------------------+----------+---------------------------+ | ||
| 2ca000f | email | [email protected] | 123456 | 2016-04-29T00:58:49+08:00 | | ||
+---------+----------+------------------+----------+---------------------------+ | ||
| 3439d31 | github | hello | 123456 | 2016-04-29T00:56:26+08:00 | | ||
+---------+----------+------------------+----------+---------------------------+ | ||
| d9437f0 | email | [email protected] | 123456 | 2016-04-29T00:54:36+08:00 | | ||
+---------+----------+------------------+----------+---------------------------+ | ||
# find passwords | ||
$> onepw find mail | ||
+---------+-------+------------------+--------+---------------------------+ | ||
| 2ca000f | email | [email protected] | 123456 | 2016-04-29T00:58:49+08:00 | | ||
+---------+-------+------------------+--------+---------------------------+ | ||
| d9437f0 | email | [email protected] | 123456 | 2016-04-29T00:54:36+08:00 | | ||
+---------+-------+------------------+--------+---------------------------+ | ||
# find first password | ||
$> onepw find mail -f | ||
+---------+-------+------------------+--------+---------------------------+ | ||
| 2ca000f | email | [email protected] | 123456 | 2016-04-29T00:58:49+08:00 | | ||
+---------+-------+------------------+--------+---------------------------+ | ||
# find passwords, but only show password | ||
$> onepw find mail -p | ||
123456 | ||
123456 | ||
# ^TRY: | ||
# onepw find mail -pf | ||
$> onepw find hello | ||
+---------+--------+-------+--------+---------------------------+ | ||
| 3439d31 | github | hello | 123456 | 2016-04-29T00:56:26+08:00 | | ||
+---------+--------+-------+--------+---------------------------+ | ||
# remove passwords | ||
$> onepw rm 343 | ||
deleted passwords: | ||
3439d3178f35f56f4c3d6f27e7ccc9a7 | ||
# list all passwords | ||
$> onepw ls | ||
+---------+----------+------------------+----------+---------------------------+ | ||
| ID | CATEGORY | ACCOUNT | PASSWORD | UPDATED_AT | | ||
+---------+----------+------------------+----------+---------------------------+ | ||
| 2ca000f | email | [email protected] | 123456 | 2016-04-29T00:58:49+08:00 | | ||
+---------+----------+------------------+----------+---------------------------+ | ||
| d9437f0 | email | [email protected] | 123456 | 2016-04-29T00:54:36+08:00 | | ||
+---------+----------+------------------+----------+---------------------------+ | ||
``` | ||
[Get Started](./quickstart.md) | ||
|
||
## CHANGELOG | ||
### CHANGELOG | ||
|
||
[ChangeLog](https://github.com/mkideal/onepw/blob/master/CHANGELOG.md) | ||
[ChangeLog](./CHANGELOG.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
Oops, something went wrong.