path: root/README.md

npass
=====
![npass.png](https://static.sinanmohd.com/git/npass.png)

npass is a [passwordstore](https://www.passwordstore.org/) and
[Secret Service API](https://specifications.freedesktop.org/secret-service/latest/)
implementation. This is still a work in progress, contributions are appreciated.
Send patches to e-mail address or matrix room listed in the [Contact](#Contact)
section.

Todo
====
- [x] npass (cli)
    - [x] pass init
    - [x] pass ls
    - [x] pass rm
    - [x] pass add
    - [x] pass gen
    - [x] pass cat
    - [x] pass help
- [ ] npassd (dbus)
    - [ ] org.freedesktop.Secret.Service
        - [x] OpenSession
        - [ ] CreateCollection
        - [ ] SearchItems
        - [ ] Unlock
        - [ ] Lock
        - [ ] GetSecrets
        - [ ] ReadAlias
        - [ ] SetAlias
        - [ ] CollectionCreated
        - [ ] CollectionDeleted
        - [ ] CollectionChanged
        - [ ] READ
    - [x]  org.freedesktop.Secret.Session
        - [x] Close
    - [ ] org.freedesktop.Secret.Item
    - [ ] org.freedesktop.Secret.Collection
    - [ ] org.freedesktop.Secret.Prompt
- [x] nix flake
    - [x] shell
    - [x] pkg
    - [ ] module

Dependencies
============
- meson (*)
- pkg-config (*+)
- gpgme
- sqlite (+)
- basu, elogind or systemd (+)

_\* build-time dependency, + npassd dependency_

Installation
============
nix
---
```
nix profile install github:sinanmohd/npass
```
meson
-----
```
git clone https://git.sinanmohd.com/npass
cd npass
meson setup build --buildtype release
meson compile -C build
meson install -C build
```

Contact
=======
- matrix: [#chat:sinanmohd.com](https://matrix.to/#/#chat:sinanmohd.com)
- e-mail: sinan [at] sinanmohd.com