Metadata-Version: 2.1
Name: onep
Version: 0.6.1
Summary: 1Password CLI helper
Home-page: https://github.com/apognu/1p
License: MIT
Keywords: password,1password,cli,secrets
Author: Antoine POPINEAU
Author-email: antoine@popineau.eu
Requires-Python: >=3.7
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Security
Classifier: Topic :: Utilities
Requires-Dist: inquirer (>=2.9.2,<3.0.0)
Requires-Dist: keyring (>=23.5.0,<24.0.0)
Requires-Dist: phonenumbers (>=8.12.48,<9.0.0)
Requires-Dist: prettytable (>=3.3.0,<4.0.0)
Requires-Dist: termcolor (>=1.1.0,<2.0.0)
Requires-Dist: validators (>=0.19.0,<0.20.0)
Project-URL: Repository, https://github.com/apognu/1p
Description-Content-Type: text/markdown

# 1p - 1Password CLI helper

`1p` is a wrapper around 1Password's `op` CLI tool to give a more user-friendly interface to secret retrieval.

Requires Python >= 3.7.

It opens a session with 1Password and stores the session token in the system's keyring, optionally, you can run with `ONEP_SECRET_BACKEND=plain` to store it under `~/.cache/1p`.

It requires that the configured 1Password account has a shorthand defined (when using `op account add`).

## Installation

```shell
$ # From PyPI
$ pip install onep

$ # Development build from GitHub
$ https://github.com/apognu/1p/releases/download/tip/onep-tip-py3-none-any.whl
```

## Usage

```shell
$ 1p --help
usage: 1p [-h] [-j] ACCOUNT COMMAND ...

positional arguments:
  ACCOUNT     shorthand of the 1Password account
  COMMAND
    signin    authenticate into a 1Password account
    vaults    list available vaults
    vault     show information about a vault
    search    search entries matching provided term
    show      display an entry
    create    create an entry
    edit      edit an entry
    delete    delete an entry
    download  download a document
    upload    upload a document
    share     get a shareable link to an item

options:
  -h, --help  show this help message and exit
  -j, --json  format output as JSON

$ 1p personal search -t social
ID                            TITLE
__________________________    GitHub
__________________________    Twitter
```

## Item creation syntax

Item creation syntax tries to determine the type of the provided values (URLs, email addresses and phone numbers), if possible. It also provides some utility to control the way values are entered and interpreted:

 * `field=` will set the type as `password` and prompt for the value interactively
 * `field=-` will set the type as `password` and generate a random value
 * `@field=value` will explicitely set the type as `password`
 * `+field=totpsecret` will consider the provided value as a TOTP secret key
 * `section.field=value` will create a field under a named section

