go-pbolt-cli

command module
v0.5.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 10, 2026 License: MIT Imports: 3 Imported by: 0

README ΒΆ

go-pbolt-cli

pbolt logo

Fast, automation-friendly CLI tool and credential helper compatible with Passbolt.

Latest Release go-pbolt SDK


⚑ Overview

pbolt (go-pbolt-cli) is a community-driven CLI tool designed to interact with Passbolt, an open-source password manager for teams.

It is built for developers, system administrators, and CI/CD automation pipelines that need reliable, scriptable secret management without compromising cryptographic security.

If you are developing Go applications and need an API client, check out our SDK: go-pbolt.


πŸ”’ API Compatibility

go-pbolt-cli is fully wire-compatible with standard Passbolt server instances (Community and Pro).

[!IMPORTANT] Compatibility is continuously tested against Passbolt API 5.6.1 and later versions.


πŸ“¦ Installation

Download Pre-built Binary

Download the archive or deb/rpm package for Linux, macOS, or Windows from our Releases page.

For Debian/Ubuntu:

sudo dpkg -i pbolt_*_linux_amd64.deb
Via Go Install
go install github.com/pbolt-dev/go-pbolt-cli@latest

(Note: Installing via Go installs the binary using the Go module path. Release packages include tab completions and manpages).


πŸš€ Getting Started

To get started, configure your server connection, private key, and credentials:

pbolt configure --serverAddress https://passbolt.example.org --userPassword 'your-passphrase' --userPrivateKeyFile 'keys/privatekey.asc'

Alternatively, you can supply your private key directly via --userPrivateKey:

pbolt configure --serverAddress https://passbolt.example.org --userPassword 'your-passphrase' --userPrivateKey '-----BEGIN PGP PRIVATE KEY BLOCK-----...'
Configuration Files & Locations

pbolt configure prioritizes modern XDG configuration directories:

  • Primary: $XDG_CONFIG_HOME/pbolt/pbolt.toml (~/.config/pbolt/pbolt.toml)
  • Backward compatibility: Existing configurations in ~/.config/go-passbolt-cli/go-passbolt-cli.toml are automatically discovered and supported.

The configuration file is maintained with strict 0600 permissions (readable only by you) in a 0700 directory.


πŸ’‘ Usage

The CLI follows a standard command structure:

pbolt <action> <entity> [arguments]
  • <action>: create, get, list, update, delete, share, etc.
  • <entity>: resource (passwords/secrets), folder, user, group.
Examples

Create a password resource:

pbolt create resource --name "Production Database" --password "super-secret-password"

List users:

pbolt list user --column id,username,role

Share a password:

pbolt share resource --id <RESOURCE_ID> --type 1 --user <USER_ID>

(Permission types: 1 = Read-only, 7 = Update, 15 = Owner, -1 = Revoke).


πŸ›‘οΈ Multi-Factor Authentication (MFA)

TOTP MFA is supported across three modes:

Mode Description
none Fails immediately if MFA challenge is issued by server.
interactive-totp (Default) Interactively prompts for TOTP code in your terminal.
noninteractive-totp Automatically generates TOTP codes using the --mfaTotpToken secret.

πŸ€– Automation & Scripting

  • JSON Output: Use -j or --json with get, list, and create for structured machine-readable output.
  • Environment Secret Injection (exec): Injects secrets directly into child processes without writing to shell history or disk:
    export GITHUB_TOKEN=passbolt://<RESOURCE_ID>
    pbolt exec -- gh auth login
    

βš–οΈ Trademark Notice

Passbolt is a registered trademark of Passbolt SA. pbolt is an independent community project and is not affiliated with, endorsed by, or sponsored by Passbolt SA.


πŸ“„ License

This project is licensed under the MIT License.

Documentation ΒΆ

The Go Gopher

There is no documentation for this package.

Directories ΒΆ

Path Synopsis
internal
cmd
Package cmd implements the top-level CLI commands for go-passbolt-cli.
Package cmd implements the top-level CLI commands for go-passbolt-cli.
cmd/folder
Package folder implements folder-related CLI subcommands.
Package folder implements folder-related CLI subcommands.
cmd/group
Package group implements group-related CLI subcommands.
Package group implements group-related CLI subcommands.
cmd/keepass
Package keepass implements KeePass export functionality.
Package keepass implements KeePass export functionality.
cmd/resource
Package resource implements resource-related CLI subcommands.
Package resource implements resource-related CLI subcommands.
cmd/user
Package user implements user-related CLI subcommands.
Package user implements user-related CLI subcommands.
e2e/commands
Package commands defines the custom commands e2e scripts can call.
Package commands defines the custom commands e2e scripts can call.
e2e/server
Package server runs a throwaway Passbolt in Docker for integration tests.
Package server runs a throwaway Passbolt in Docker for integration tests.
util
Package util provides shared utilities for the CLI.
Package util provides shared utilities for the CLI.
util/securefile
Package securefile creates and checks files that hold secrets: the CLI config, which holds the private key and passphrase in cleartext, and the KeePass export.
Package securefile creates and checks files that hold secrets: the CLI config, which holds the private key and passphrase in cleartext, and the KeePass export.
util/securefile/posixmode
Package posixmode holds the permission-bit helpers behind securefile on Unix.
Package posixmode holds the permission-bit helpers behind securefile on Unix.
util/securefile/winacl
Package winacl holds the Windows ACL helpers behind securefile: the caller's SIDs, the private descriptor that stands in for 0600, and the check that a DACL exposes nobody else, which reads the DACL through the SDDL parser in sddl.go.
Package winacl holds the Windows ACL helpers behind securefile: the caller's SIDs, the private descriptor that stands in for 0600, and the check that a DACL exposes nobody else, which reads the DACL through the SDDL parser in sddl.go.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL