teampass-cli 0.0.10

Simple command line interface for Teampass

What is this?

It is a simple command line interface for Teampass (https://teampass.net). teampass-cli provides an executable called tplci

IMPORTANT: To use the teampass-cli, you need to modify the file api/functions.php on the server there Teampass was installed. The modified version of the file api/functions.php is located in the lib folder.

Installation

on most UNIX-like systems, you’ll probably need to run the following `install` commands as root or by using sudo

pip

pip install teampass-cli

from source

pip install git+http://github.com/verdel/teampass-cli

or

git clone git://github.com/verdel/teampass-cli.git
cd teampass-cli
python setup.py install

as a result, the tpcli executable will be installed into a system bin directory

Usage

tpcli --help
Usage: -c [OPTIONS] COMMAND [ARGS]...
Options:
  --api-endpoint TEXT  Teampass API endpoint.
  --api-key TEXT       Teampass API key.
  --help               Show this message and exit.

Commands:
  add     add entry to Teampass
  delete  delete entry from Teampass
  edit    edit entry in Teampass
  list    show entry from Teampass
  search  search entry in Teampass


tpcli add --help
Usage: -c add [OPTIONS]

Add entry to Teampass.

Options:
  --item              add item
  --folder            add folder
  --title TEXT        title for new folder or label for new item  [required]
  --login TEXT        login value for new item
  --password TEXT     password value for new item
  --description TEXT  description value for new item
  --folder-id TEXT    parent folder id  [required]
  --list              format output as list
  --table             format output as table
  --help              Show this message and exit.


tpcli delete --help
Usage: -c delete [OPTIONS]

Delete entry from Teampass.

Options:
  --item     delete item
  --folder   delete folder with sub-folders and items
  --id TEXT  entry id  [required]
  --help     Show this message and exit.


tpcli edit --help
Usage: -c edit [OPTIONS]

Edit entry in Teampass.

Options:
  --item              add item
  --folder            add folder
  --id TEXT           entry id  [required]
  --title TEXT        title for entry
  --login TEXT        login value for entry
  --password TEXT     password value for entry
  --description TEXT  description value for entry
  --folder-id TEXT    parent folder id
  --list              format output as list
  --table             format output as table
  --help              Show this message and exit.


tpcli list --help
Usage: -c list [OPTIONS]

List entry from Teampass.

Options:
  --item    show items
  --folder  show folders
  --list    format output as list
  --table   format output as table
  --tree    format output as tree
  --help    Show this message and exit.


tpcli search --help
Usage: -c search [OPTIONS] TEXT

Search entry in Teampass.

Options:
  --item    search items
  --folder  search folders
  --list    format output as list
  --table   format output as table
  --help    Show this message and exit.