Command-line client for Nextcloud’s Passman.
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Go to file
Damien Goutte-Gattat f43b1bdae6 Prepare 0.9.1 release. 2 years ago
docs Prepare 0.9.1 release. 2 years ago
incenp Prepare 0.9.1 release. 2 years ago
.gitignore Update for Eclipse/PyDev. 3 years ago
AUTHORS Update README file. 5 years ago
COPYING Initial commit. 5 years ago
MANIFEST.in Include the documentation in the source archive. 3 years ago
NEWS Prepare 0.9.1 release. 2 years ago
README.md Prepare 0.9.0 release. 2 years ago
setup.py Switch back to upstream click-shell. 2 years ago

README.md

Pebble - Command-line Passman client

Pebble is a command-line client for the Passman password manager.

It supports read and write access to Passman vaults: it can list, show, create, modify or delete entries in a vault. It cannot, however, create or delete the vaults themselves.

Configuration

Pebble requires a configuration file describing the vault(s) to use. The configuration file uses the INI syntax and is expected to be at $XDG_CONFIG_HOME/pebble/config by default; another location may be specified using the -c option.

A vault is described in the configuration file by a section like in the following example:

[default]
host: host.example.com
user: alice
password: mypassword
vault: MyVault

The file may contain several sections, one for each different vault. Use the -s option to specify the name of the section to use (and thus, which vault to connect to). By default, a section named default will be used.

Inside a vault section, the password field may be omitted, in which case the password will be asked interactively. Note: This is the Nextcloud password, not the vaults password! The vault password is always asked interactively.

Use

With at least one vault configured, Pebble may then be used through the pbl command and its subcommands. Current available subcommands are:

  • list to list credentials in the vault;
  • show to display a credentials details;
  • new to add a new credential;
  • edit to modify a credential;
  • delete to remove a credential from the vault;
  • conf to create or edit the configuration file;
  • refresh to forcefully refresh the local cache;
  • clear to empty the local cache.

In addition, calling pbl without any subcommand will start an interactive shell in which subcommands can be invoked successively without quitting the program.

Calling pbl with the -h option will display the general help; calling a given subcommand with the -h option will display the help for that subcommand.

The program will interactively for the vault passphrase when it is needed to decrypt or encrypt a credential.

Copying

Pebble is distributed under the terms of the GNU General Public License, version 3 or higher. The full license is included in the COPYING file of the source distribution.

Pebble include codes that was originally distributed under a 3-clause BSD license. The original copyright notice and license can be found in the header of any file of the source distribution containing such code.

Homepage and repository

The project is located at https://incenp.org/dvlpt/pebble.html with the manual at https://incenp.org/dvlpt/pebble/index.html. The source code is available in a Git repository at https://git.incenp.org/damien/pebble.