Android-Password-Store/README.md

# Password Store

[![GitHub workflow](https://github.com/android-password-store/Android-Password-Store/workflows/Deploy%20snapshot%20builds/badge.svg)](https://github.com/android-password-store/Android-Password-Store/actions)
[![Backers on Open Collective](https://opencollective.com/Android-Password-Store/backers/badge.svg)](#backers) [![Sponsors on Open Collective](https://opencollective.com/Android-Password-Store/sponsors/badge.svg)](#sponsors)
[![Join the chat at https://gitter.im/android-password-store/public](https://badges.gitter.im/android-password-store/public.svg)](https://gitter.im/android-password-store/public?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

This application tries to be 100% compatible with [pass](http://www.passwordstore.org/)

You can install the application from:

* [F-Droid](https://f-droid.org/packages/dev.msfjarvis.aps/)
* [Play Store](https://play.google.com/store/apps/details?id=dev.msfjarvis.aps)
* [Snapshot builds](https://dl.msfjarvis.dev/APS/)

Pull requests are more than welcome (see [TODO](https://github.com/android-password-store/Android-Password-Store/projects/1#column-228844)).

<a href="https://play.google.com/store/apps/details?id=dev.msfjarvis.aps">
  <img src="https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png" 
       alt="Get it on Google Play"
       height="80" />
</a>
<a href="https://f-droid.org/packages/dev.msfjarvis.aps">
  <img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png"
       alt="Get it on F-Droid"
       height="80" />
</a>

## Build types

We generate release binaries under two separate configurations titled `free` and `nonFree`. The distinction was created following the merge of [#900](https://msfjarvis.dev/aps/pr/900), that introduced a dependency on closed source GMS libraries. Since F-Droid is a FOSS-only app store, we created the `free` flavor where we do not ship the GMS dependency and thus the feature to fill SMS OTPs is unavailable.

## Features

* Clone an existing pass repository (ssh-key and user/pass support)
* List the passwords
* Handle the directories as categories
* Decrypt the password files (first line is the password, the rest is extra data)
* Add a new password to the current category (or no category if added at the root)
* Pull and Push changes to the remote repository
* Ability to change remote repository info

## How-To

See the [wiki](https://github.com/android-password-store/Android-Password-Store/wiki/First-time-setup) for FAQs and other thorough documentation.

## Community

Ways to get in touch:

* [Github issues](https://github.com/android-password-store/Android-Password-Store/issues), use it if you have a bug report, you do not understand how something works or you want to submit a feature request.

## Contributing Translations

Interested in helping to translate Password Store? Contribute [here](https://crowdin.com/project/android-password-store)!

## Contributors

This project exists thanks to all the people who contribute. Want to contribute? See if you can [find an issue](https://github.com/android-password-store/Android-Password-Store/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) you wanna close, then send a PR!

[![Opencollective](https://opencollective.com/Android-Password-Store/contributors.svg?width=890&button=false)](https://github.com/android-password-store/Android-Password-Store/graphs/contributors)

## Backers

Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/Android-Password-Store#backer)]

[![Backers](https://opencollective.com/Android-Password-Store/backers.svg?width=890)](https://opencollective.com/Android-Password-Store#backers)

## Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website.[[Become a sponsor](https://opencollective.com/Android-Password-Store#sponsor)]

[![Triplebyte](https://opencollective.com/Android-Password-Store/sponsor/0/avatar.svg)](https://opencollective.com/Android-Password-Store/sponsor/0/website)
[![Applicative GmbH](https://opencollective.com/Android-Password-Store/sponsor/1/avatar.svg)](https://opencollective.com/Android-Password-Store/sponsor/1/website)
[![ScrapingBee](https://opencollective.com/Android-Password-Store/sponsor/2/avatar.svg)](https://opencollective.com/Android-Password-Store/sponsor/2/website)
[![Become a Sponsor](https://opencollective.com/Android-Password-Store/sponsor/3/avatar.svg)](https://opencollective.com/Android-Password-Store/sponsor/3/website)

<sub>Google Play and the Google Play logo are trademarks of Google LLC.</sub>