tpcli

tpcli is a command line interface tool for interacting with the TeamPass software through its API.

Installation

1/ Installing dependencies:
- requests

2/ A pip package is under construction but in the meantime, simply copying the tpcli.py file in your path & marking it as executable should be enough.

cp tpcli.py /usr/local/bin/
chmod +x /usr/local/bin/tpcli.py

3/ Populate a configuration file in an INI format under $HOME/.tpcli/config containing at least the following entries:
Please note the [global] section is mandatory.

[global]
API_KEY=<your api key here>
URL=<scheme://prefix.domain>

4/ Search for your items:

tpcli.py myItem

Configuration file properties

In addition to the two properties mentioned above, there are a number of other properties that make your interaction with tpcli more useful.
A description of each field follows:
a/ API_KEY: self-definitory: this is the API key as generated inside TeamPass.
b/ URL: the URL to your TeamPass installation. Some examples might be:

URL=http://teampass.foo.bar

or

URL=https://foo.bar/teampass

c/ TRUSTED: boolean value. When using a self-signed certificate, you should mark the URL as trused, otherwise tpcli.py will refuse to connect to that instance.
d/ DIR_IDS: each TeampPass directory has an id associated with it.
The bad news: TeamPass's API needs to know where to start its search of the item you're requesting.
The good news: the search is recursive :^)
This means that if you have a root directory that hosts subdirectories you can get away with setting DIR_IDS to the root directory id.
If you have multiple directories at the root level, you will need to specify all of them (separated by colon) for the API to search into all of them.
Example:

DIR_IDS=1;2;3

License and disclaimer

This software is released under the GPL v3 software license.
Please see the LICENSE file for a complete copy of it.

I am in no way affiliated with TeamPass or its author.
It is just software I enjoy working with but felt the need of extending.
You can find out more about TeamPass from its official website at
teampass.net

History

While working for a former employer, I wrote a bash script for interacting with the TeamPass API in a number of ways, like:
- showing
- deleting
- updating
- adding
items.
The intelectual property for that software was not mine and they wouldn't agree on releasing it as free software.
That plus the fact that I wanted to learn a programming language led me to writing tpcli :^)