gpm/README.md

77 lines
2.2 KiB
Markdown
Raw Normal View History

2019-07-01 06:03:41 +00:00
# gpm: Go Passwords Manager
2020-12-23 13:13:36 +00:00
[![Version](https://img.shields.io/badge/latest_version-2.0.0-green.svg)](https://git.yaegashi.fr/nishiki/gpm/releases)
2019-07-24 16:21:21 +00:00
[![Build Status](https://travis-ci.org/nishiki/gpm.svg?branch=master)](https://travis-ci.org/nishiki/gpm)
[![GoReport](https://goreportcard.com/badge/git.yaegashi.fr/nishiki/gpm)](https://goreportcard.com/report/git.yaegashi.fr/nishiki/gpm)
[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](https://git.yaegashi.fr/nishiki/gpm/src/branch/master/LICENSE)
2019-07-01 06:03:41 +00:00
gpm is passwords manager write in go and use AES-256 to encrypt the wallets
## Features
- generate TOTP code
2019-07-01 06:03:41 +00:00
- copy your login, password or otp in clipboard
- manage multiple wallets
2019-07-16 20:56:17 +00:00
- generate random password
2019-07-01 06:03:41 +00:00
## Install
2019-07-23 17:20:08 +00:00
- Install [golang](https://golang.org/doc/install)
- Add `~/go/bin` in your `PATH`
- Download and build
2019-07-01 06:03:41 +00:00
2019-07-23 17:20:08 +00:00
```text
go get git.yaegashi.fr/nishiki/gpm/cmd/gpm
```
## How to use
2020-12-23 13:13:36 +00:00
### First launch
2019-07-23 17:20:08 +00:00
2020-12-23 13:13:36 +00:00
- Run `gpm`
- Enter the passphrase to encrypt your new wallet
- Press `n` to create your first entry and follow the instructions
2019-07-01 06:03:41 +00:00
2019-07-23 17:20:08 +00:00
### All options
2019-07-01 06:03:41 +00:00
```text
-config string
2020-12-23 13:13:36 +00:00
specify the config file
2019-07-23 17:20:08 +00:00
-digit
2020-12-23 13:13:36 +00:00
use digit to generate a random password
-export string
json file path to export a wallet
2019-07-01 06:03:41 +00:00
-help
2020-12-23 13:13:36 +00:00
print this help message
2019-07-23 17:20:08 +00:00
-import string
2020-12-23 13:13:36 +00:00
json file path to import entries
2019-07-23 17:20:08 +00:00
-length int
2020-12-23 13:13:36 +00:00
specify the password length (default 16)
2019-07-23 17:20:08 +00:00
-letter
2020-12-23 13:13:36 +00:00
use letter to generate a random password
2019-07-23 17:20:08 +00:00
-password
2020-12-23 13:13:36 +00:00
generate and print a random password
2019-07-23 17:20:08 +00:00
-special
2020-12-23 13:13:36 +00:00
use special chars to generate a random password
2019-07-23 17:20:08 +00:00
-wallet string
2020-12-23 13:13:36 +00:00
specify the wallet
2019-07-01 06:03:41 +00:00
```
## License
```text
Copyright (c) 2019 Adrien Waksberg
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```