damien
/
pebble
2
0
Fork 1
Code Issues Pull Requests Releases 12 Wiki Activity
Command-line client for Nextcloud’s Passman.
122 Commits 1 Branch 12 Tags 430 KiB
Python 100%
Go to file
Damien Goutte-Gattat 1f53dfcaba
Handle possible corruption of the `info` file. 
It may happen (it actually happened at least once) that the `info` file
exists in the on-disk cache, but is somehow corrupt and does not contain
the expected data.

If the contents of the file cannot be decoded as valid JSON, or if it is
decoded as nothing, we act as if the file did not exist and get the data
straight from the server.
 		2022-11-15 22:01:44 +00:00
docs Prepare 1.0.0 release. 2021-08-15 21:14:27 +01:00
incenp Handle possible corruption of the `info` file. 2022-11-15 22:01:44 +00:00
.gitignore Update for Eclipse/PyDev. 2020-10-22 22:01:49 +01:00
AUTHORS Update distribution files. 2021-07-30 10:12:37 +01:00
COPYING Initial commit. 2018-01-30 11:11:14 +00:00
MANIFEST.in Include the documentation in the source archive. 2020-10-04 20:47:18 +01:00
NEWS Prepare new release. 2022-05-07 20:52:26 +01:00
README.md Remove obsolete notice about BSD-licensed code. 2022-05-08 11:37:07 +01:00
pyproject.toml Switch to Black-enforced code style. 2022-06-03 21:44:00 +01:00
setup.py Switch to Black-enforced code style. 2022-06-03 21:44:00 +01:00

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 vault’s 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 credential’s details;
  • new to add a new credential;
  • edit to modify a credential;
  • delete to remove a credential from the vault;
  • export to dump all credentials to a file;
  • 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.

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.