edwh-passbolt-plugin

Table of Contents

• Installation
• Usage
• License

Installation

edwh plugin.add passbolt

If you don't have edwh yet:

uvenv install edwh[passbolt]
# or pipx, pip, ...

Usage

Typical flow starts with a login:

edwh passbolt.login

You will be prompted for:

• Passbolt host URL (e.g. https://passbolt.edwh.nl).
• Your Passbolt user UUID (find it in the Passbolt UI under users; it is in the URL).
• How to import a private key: provide a path to a recovery kit, paste a PGP private key block, or skip.
• Your GPG key passphrase.

After login, your OS may occasionally show a passphrase prompt popup (via gpg-agent/pinentry). This depends on your system and the GPG Agent cache/expiry time.

For unattended commands, first create the local session with edwh passbolt.login, then set PASSBOLT_GPG_PASSPHRASE to the passphrase for that session's GPG key. The plugin uses it to unlock the encrypted session and perform required GPG operations.

Main commands:

edwh passbolt.list [--folder ...]
edwh passbolt.get <name-or-id> [--field password|user|uri]
edwh passbolt.set [--name ...] [--password ...] [--username ...] [--uri ...] [--folder ...]
edwh passbolt.set-note --title ... [--content ...] [--folder ...]
edwh passbolt.search <term> [--limit 10] [--threshold 70]
edwh passbolt.list-folders
edwh passbolt.delete <name-or-id>
edwh passbolt.share <name-or-id> [--user "Alice, Bob"] [--group "Admins"] [--permission read|update|owner]
edwh passbolt.unshare <name-or-id> [--user "Alice, Bob"] [--group "Admins"]

passbolt.set-note creates a note when the title does not exist and updates it otherwise. It also has passbolt.add-note and passbolt.update-note aliases. When content is piped in, it is read from stdin unchanged:

cat .env | edwh passbolt.set-note --title "Development environment" --folder Development

Notes use the same passbolt.get, passbolt.delete, passbolt.share, and passbolt.unshare commands as passwords. passbolt.get prints only the note content for a note resource.

For full command listings and help text:

edwh help passbolt
edwh help passbolt.<command>

License

edwh-passbolt-plugin is distributed under the terms of the MIT license.