passforios/README.md

59 lines
2.7 KiB
Markdown
Raw Normal View History

2018-12-09 16:59:07 -08:00
<img src="icon/icon_round.png" width="76"/>
2017-01-24 18:03:07 +08:00
2017-02-15 22:15:19 +08:00
# Pass
2018-01-17 10:54:52 -08:00
[![GitHub release](https://img.shields.io/github/release/mssun/passforios.svg)](https://github.com/mssun/passforios/releases)
2017-03-11 18:11:50 -08:00
[![Gitter](https://img.shields.io/gitter/room/nwjs/nw.js.svg)](https://gitter.im/passforios/passforios)
2017-03-26 21:37:37 -07:00
[![Build Status](https://travis-ci.org/mssun/passforios.svg?branch=develop)](https://travis-ci.org/mssun/passforios)
2018-08-14 20:29:27 -07:00
[![Donate](https://img.shields.io/badge/paypal-donate-blue.svg)](https://www.paypal.me/mssun)
2017-02-06 00:29:14 +08:00
2018-08-14 20:29:27 -07:00
Pass is an iOS client compatible with [ZX2C4's Pass command line application](http://www.passwordstore.org/).
It is a password manager using GPG for encryption and Git for version control.
2017-01-24 22:48:18 +08:00
2019-07-13 16:06:36 -07:00
Pass for iOS is available in App Store with the name "Pass - Password Store", and both iPhone and iPad are supported.
2017-10-28 18:23:15 +08:00
<p>
<a href="https://itunes.apple.com/us/app/pass-password-store/id1205820573?mt=8"><img alt="Download on the App Store" src="img/app_store_badge.svg" width="150"/></a>
2017-10-28 18:23:15 +08:00
</p>
You can also help us test beta versions through [TestFlight](https://testflight.apple.com/join/whK4zUFG).
2017-02-17 21:55:40 +08:00
2017-02-16 15:47:00 +08:00
## Features
2019-07-13 16:06:36 -07:00
- Compatible with the Password Store command line tool.
- View, copy, add, and edit password entries.
- Encrypt and decrypt password entries by PGP keys.
- Synchronize with your password Git repository.
2017-02-19 00:34:08 +08:00
- User-friendly interface: search, long press to copy, copy and open link, etc.
2019-07-13 16:06:36 -07:00
- Support one-time password tokens (two-factor authentication codes).
- Autofill in Safari/Chrome and [supported apps](https://github.com/agilebits/onepassword-app-extension).
2017-02-16 15:47:00 +08:00
2017-02-06 00:49:23 +08:00
## Screenshots
2017-03-20 19:40:35 -07:00
<p>
<img src="img/screenshot1.png" width="200"/>
<img src="img/screenshot2.png" width="200"/>
<img src="img/screenshot3.png" width="200"/>
2019-07-13 16:06:36 -07:00
<img src="img/screenshot4.png" width="200"/>
2017-03-20 19:40:35 -07:00
</p>
2017-02-12 11:09:45 +08:00
## Usages
- Setup your password-store ([official `Pass` introduction](https://www.passwordstore.org/))
2017-06-25 22:07:53 +08:00
- Get Pass for iOS from the App Store or [build by yourself](https://github.com/mssun/passforios/wiki/Building-Pass-for-iOS)
- Setup Pass for iOS ([quick-start guide](https://github.com/mssun/passforios/wiki#quick-start-guide-for-pass-for-ios))
2019-07-13 16:06:36 -07:00
For more, please read the [wiki page](https://github.com/mssun/passforios/wiki).
## Building Pass for iOS
2017-02-16 14:47:48 +08:00
1. Install libtool, automake, cmake, carthage, cocoapods, and go: `brew install libtool automake cmake carthage cocoapods go swiftlint swiftformat`.
2. Install dependencies via Carthage in the project root directory: `./wcarthage update` then `./wcarthage bootstrap --platform iOS`. This may take some time.
2019-06-08 17:45:47 -07:00
3. Run `./gopenpgp_build.sh` to build go dependencies.
4. Install dependencies via CocoaPods in the project root directory: `pod install`.
5. Open the `pass.xcworkspace` file in Xcode.
2019-09-28 15:19:02 +08:00
6. Build & Run.
2017-02-16 14:47:48 +08:00
2017-02-12 11:12:30 +08:00
## License
MIT