• Home
  • History
  • Annotate
Name Date Size #Lines LOC

..03-May-2022-

.github/H13-Nov-2021-326276

docs/H03-May-2022-2,4031,678

helpers/H13-Nov-2021-1,2401,004

internal/H13-Nov-2021-28,07122,202

pkg/H13-Nov-2021-14,10612,445

tests/H13-Nov-2021-1,8851,476

vendor/H03-May-2022-1,193,237975,979

.codeclimate.ymlH A D13-Nov-2021614 4540

.codecov.ymlH A D13-Nov-2021183 1413

.errcheck.exclH A D13-Nov-202136 43

.gitignoreH A D13-Nov-2021548 5844

.goreleaser.ymlH A D13-Nov-20211.9 KiB9890

.revive.tomlH A D13-Nov-2021911 4034

ARCHITECTURE.mdH A D13-Nov-202110.2 KiB236167

CHANGELOG.mdH A D13-Nov-202130.6 KiB724608

CONTRIBUTING.mdH A D13-Nov-20216.3 KiB202136

GOVERNANCE.mdH A D13-Nov-20211 KiB2718

LICENSEH A D13-Nov-20211.1 KiB105

MakefileH A D13-Nov-20217.5 KiB213181

README.mdH A D13-Nov-20219.8 KiB186133

VERSIONH A D13-Nov-20217 21

bash.completionH A D13-Nov-2021320 1210

fish.completionH A D13-Nov-202133.3 KiB310301

go.modH A D13-Nov-20212.4 KiB5653

go.sumH A D13-Nov-202148.5 KiB500499

gopass.1H A D13-Nov-202114.8 KiB516452

main.goH A D13-Nov-20216.6 KiB273220

main_test.goH A D13-Nov-20213.9 KiB166142

version.goH A D13-Nov-2021398 2723

zsh.completionH A D13-Nov-202113 KiB355264

README.md

1<p align="center">
2    <img src="docs/logo.png" height="250" alt="gopass Gopher by Vincent Leinweber, remixed from the Renée French original Gopher" title="gopass Gopher by Vincent Leinweber, remixed from the Renée French original Gopher" />
3</p>
4
5# gopass
6
7[![Build Status](https://img.shields.io/github/workflow/status/gopasspw/gopass/Build%20gopass/master)](https://github.com/gopasspw/gopass/actions/workflows/build.yml?query=branch%3Amaster)
8[![Packaging status](https://repology.org/badge/tiny-repos/gopass.svg)](https://repology.org/project/gopass/versions)
9[![Go Report Card](https://goreportcard.com/badge/github.com/gopasspw/gopass)](https://goreportcard.com/report/github.com/gopasspw/gopass)
10[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/gopasspw/gopass/blob/master/LICENSE)
11[![Github All Releases](https://img.shields.io/github/downloads/gopasspw/gopass/total.svg)](https://github.com/gopasspw/gopass/releases)
12[![codecov](https://codecov.io/gh/gopasspw/gopass/branch/master/graph/badge.svg)](https://codecov.io/gh/gopasspw/gopass)
13[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/1899/badge)](https://bestpractices.coreinfrastructure.org/projects/1899)
14[![Gopass Slack](https://img.shields.io/badge/%23gopass-Slack-brightgreen)](https://docs.google.com/forms/d/e/1FAIpQLScxOPX_OLDaG5ak2E1kNdcFw9fJvPCr8xUaPGLyW8cyNUEnJw/viewform?usp=sf_link)
15
16## Introduction
17
18gopass is a password manager for the command line written in Go. It supports all major operating systems (Linux, MacOS, BSD) as well as Windows.
19
20For detailed usage and installation instructions please check out our [documentation](docs/).
21
22## Design Principles
23
24Gopass is a versatile command line based password manager that is being developed with the following principles in mind:
25
26- **Easy**: For technical users (i.e. those who are used to the command line) it should be easy to get started with gopass.
27- **Secure**: Security is hard. We aim to make it as easy as possible while still providing a good level of protection against common adversaries. *Caution*: If your personal threat level is very high, we might not offer a good tool for you.
28- **Extensible**: While Gopass includes a fair amount of useful features, we can't cover every use-case. To support more special use cases we want to provide a clean and simple API to integration gopass into your own binaries.
29
30## Screenshot
31
32![screenshot](docs/showcase.png)
33
34## Features
35
36Please see [docs/features.md](https://github.com/gopasspw/gopass/blob/master/docs/features.md) for an extensive list of all features along with several usage examples. Some examples are available in our
37[example password store](https://github.com/gopasspw/password-store-example).
38
39| **Feature**                 | **State**     | **Description**                                                   |
40| --------------------------- | ------------- | ----------------------------------------------------------------- |
41| Secure secret storage       | *stable*      | Securely storing encrypted secrets                                |
42| Recipient management        | *beta*        | Easily manage multiple users of each store                        |
43| Multiple stores             | *stable*      | Mount multiple stores in your root store, like file systems       |
44| password quality assistance | *beta*        | Checks existing or new passwords for common flaws                 |
45| password leak checker       | *integration* | Perform **offline** checks against known leaked passwords         |
46| PAGER support               | *stable*      | Automatically invoke a pager on long output                       |
47| JSON API                    | *integration* | Allow gopass to be used as a native extension for browser plugins |
48| Automatic fuzzy search      | *stable*      | Automatically search for matching store entries if a literal entry was not found |
49| gopass sync                 | *stable*      | Easy to use syncing of remote repos and GPG keys                  |
50| Desktop Notifications       | *stable*      | Display desktop notifications and completing long running operations |
51| REPL                        | *beta*        | Integrated Read-Eval-Print-Loop shell with autocompletion. |
52| Extensions                  |               | Extend gopass with custom commands using our API                  |
53
54## Installation
55
56Please see [docs/setup.md](https://github.com/gopasspw/gopass/blob/master/docs/setup.md).
57
58If you have [Go](https://golang.org/) 1.16 (or greater) installed:
59
60```bash
61go get github.com/gopasspw/gopass
62```
63
64WARNING: Please prefer releases, unless you want to contribute to the
65development of gopass. The master branch might not be very well tested and
66can contain breaking changes without further notice.
67
68## Getting Started
69
70Either initialize a new git repository or clone an existing one.
71
72### New password store
73
74```
75$ gopass setup
76
77   __     _    _ _      _ _   ___   ___
78 /'_ '\ /'_'\ ( '_'\  /'_' )/',__)/',__)
79( (_) |( (_) )| (_) )( (_| |\__, \\__, \
80'\__  |'\___/'| ,__/''\__,_)(____/(____/
81( )_) |       | |
82 \___/'       (_)
83
84�� Welcome to gopass!
85�� Initializing a new password store ...
86�� Configuring your password store ...
87�� Please select a private key for encrypting secrets:
88[0] gpg - 0xFEEDBEEF - John Doe <john.doe@example.org>
89Please enter the number of a key (0-12, [q]uit) (q to abort) [0]: 0
90❓ Do you want to add a git remote? [y/N/q]: y
91Configuring the git remote ...
92Please enter the git remote for your shared store []: git@gitlab.example.org:john/passwords.git
93✅ Configured
94```
95
96Hint: `gopass setup` will use `gpg` encryption and `git` storage by default.
97
98### Existing password store
99
100```
101$ gopass clone git@gitlab.example.org:john/passwords.git
102
103   __     _    _ _      _ _   ___   ___
104 /'_ '\ /'_'\ ( '_'\  /'_' )/',__)/',__)
105( (_) |( (_) )| (_) )( (_| |\__, \\__, \
106'\__  |'\___/'| ,__/''\__,_)(____/(____/
107( )_) |       | |
108 \___/'       (_)
109
110�� Welcome to gopass!
111�� Cloning an existing password store from "git@gitlab.example.org:john/passwords.git" ...
112⚠ Cloning git repository "git@gitlab.example.org:john/passwords.git" to "/home/john/.local/share/gopass/stores/root" ...
113⚠ Configuring git repository ...
114�� Gathering information for the git repository ...
115�� What is your name? [John Doe]:
116�� What is your email? [john.doe@example.org]:
117Your password store is ready to use! Have a look around: `gopass list`
118```
119
120## Upgrade
121
122To use the self-updater run:
123```bash
124gopass update
125```
126
127or to upgrade with Go installed, run:
128```bash
129go get -u github.com/gopasspw/gopass
130```
131
132Otherwise, use the setup docs mentioned in the installation section to reinstall the latest version.
133
134## Development
135
136This project uses [GitHub Flow](https://guides.github.com/introduction/flow/). In other words, create feature branches from master, open an PR against master, and rebase onto master if necessary.
137
138We aim for compatibility with the [latest stable Go Release](https://golang.org/dl/) only.
139
140While this project is maintained by volunteers in their free time we aim to triage issues weekly and release a new version at least every quarter.
141
142## Credit & License
143
144gopass is licensed under the terms of the MIT license. You can find the complete text in `LICENSE`.
145
146Please refer to the Git commit log for a complete list of contributors.
147
148## Community
149
150gopass is developed in the open. Here are some of the channels we use to communicate and contribute:
151
152* Issue tracker: Use the [GitHub issue tracker](https://github.com/gopasspw/gopass/issues) to file bugs and feature requests.
153
154## Integrations
155
156- [gopassbridge](https://github.com/gopasspw/gopassbridge): Browser plugin for Firefox, Chrome and other Chromium based browsers
157- [kubectl gopass](https://github.com/gopasspw/kubectl-gopass): Kubernetes / kubectl plugin to support reading and writing secrets directly from/to gopass.
158- [gopass alfred](https://github.com/gopasspw/gopass-alfred): Alfred workflow to use gopass from the Alfred Mac launcher
159- [git-credential-gopass](https://github.com/gopasspw/git-credential-gopass): Integrate gopass as an git-credential helper
160- [gopass-hibp](https://github.com/gopasspw/gopass-hibp): haveibeenpwned.com leak checker
161- [gopass-jsonapi](https://github.com/gopasspw/gopass-jsonapi): native messaging for browser plugins, e.g. gopassbridge
162- [gopass-summon-prover](https://github.com/gopasspw/gopass-summon-provider): gopass as a summon provider
163- [`terraform-provider-gopass`](https://github.com/camptocamp/terraform-provider-pass): a Terraform provider to interact with gopass
164- [chezmoi](https://github.com/twpayne/chezmoi): dotfile manager with gopass support
165
166## Mobile apps
167
168- [Pass - Password Store](https://apps.apple.com/us/app/pass-password-store/id1205820573) - iOS, [source code](https://github.com/mssun/passforios), [supports only 1 repository now](https://github.com/mssun/passforios/issues/88)
169- [Password Store](https://play.google.com/store/apps/details?id=dev.msfjarvis.aps) - Android
170
171## Contributing
172
173We welcome any contributions. Please see the [CONTRIBUTING.md](https://github.com/gopasspw/gopass/blob/master/CONTRIBUTING.md) file for instructions on how to submit changes.
174
175## Further Documentation
176
177* [Security, Known Limitations, and Caveats](https://github.com/gopasspw/gopass/blob/master/docs/security.md)
178* [Configuration](https://github.com/gopasspw/gopass/blob/master/docs/config.md)
179* [FAQ](https://github.com/gopasspw/gopass/blob/master/docs/faq.md)
180* [JSON API](https://github.com/gopasspw/gopass-jsonapi)
181* [Gopass as Summon provider](https://github.com/gopasspw/gopass-summon-provider)
182
183## External Documentation
184* [gopass cheat sheet](https://woile.github.io/gopass-cheat-sheet/) ([source on github](https://github.com/Woile/gopass-cheat-sheet))
185* [gopass presentation](https://woile.github.io/gopass-presentation/) ([source on github](https://github.com/Woile/gopass-presentation))
186