ps-cli

The Password Safe CLI Application is an efficient Command Line Interface (CLI) tool specifically crafted to interface with the Beyond Insight and Password Safe APIs (version 24.3). This application allows users to access various API resources, including safes, folders, secrets, managed accounts, and more. It offers a user-friendly interface that simplifies command parsing, ensures input validation, and delivers detailed output.

Available environment variables

Required:

PSCLI_API_URL: Beyond Insight and Password Safe API URL. This can also be set in the settings file.
PSCLI_CLIENT_ID: Client ID to use when requesting data from the API. This can also be set in the settings file.
PSCLI_CLIENT_SECRET: Client secret to use when requesting data from the API. This can also be set in the settings file.

Optional:

PSCLI_SETTINGS_PATH: Custom settings path to use for ps-cli. By default, the settings file is created in the user's home directory (~).
PSCLI_AUTH_RETRIES: The number of times ps-cli should attempt to authenticate in case of an error.
PSCLI_TIMEOUT_CONNECTION: How long to wait for the server to connect and send data before giving up. Integer value defined in seconds, by default 30 seconds.
PSCLI_TIMEOUT_REQUEST: How long to wait for each request made to the API. Defined in seconds, by default 30 seconds.
PSCLI_VERIFY_CA: Set to false to disable SSL certificate verification (useful for self-signed certificates). By default, SSL verification is enabled for secure connections.

Prerequisites

Python 3.12+
Password Safe version 24.3

Getting started

Install ps-cli (package name: beyondtrust-bips-cli)

pip install beyondtrust-bips-cli

Check that ps-cli is properly installed:

ps-cli -h
# Output usage instructions:
usage: ps-cli [-h] [-v] [-l {DEBUG,INFO,WARNING,ERROR,CRITICAL}] [--format {json,csv,tsv}] [--delimiter {,,;,   ,|, }]
              [-av {3.0,3.1}]
              {safes,folders,secrets,settings} ...

Create the settings file using:

By default, the settings file is created in the user's home directory (~). If you would like to specify a custom path for the settings, you can achieve this by setting the PSCLI_SETTINGS_PATH environment variable. If you're using the custom settings path (PSCLI_SETTINGS_PATH), set it before running the settings initialization command:

ps-cli settings initialize-settings

After creating the settings file, proceed to edit it and configure the api_url, client_id, and client_secret, in case you did not define this configuration using the available environment variables (PSCLI_API_URL, PSCLI_CLIENT_ID and PSCLI_CLIENT_SECRET).

You can find more details on ps-cli official documentation.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

beyondtrust_bips_cli-0.14.3.tar.gz (91.5 kB view details)

Uploaded Sep 1, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

beyondtrust_bips_cli-0.14.3-py3-none-any.whl (142.1 kB view details)

Uploaded Sep 1, 2026 Python 3

File details

Details for the file beyondtrust_bips_cli-0.14.3.tar.gz.

File metadata

Download URL: beyondtrust_bips_cli-0.14.3.tar.gz
Upload date: Sep 1, 2026
Size: 91.5 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for beyondtrust_bips_cli-0.14.3.tar.gz
Algorithm	Hash digest
SHA256	`f0d4898fb507cc7618d8a08544ae1009c39a22266692fdb3b39b8cd28497add8`
MD5	`55507a2bcd4201b443124b0cd85827c8`
BLAKE2b-256	`3923213b595770ef75a81fc9d9ed4d4c09dd520e560f3d6a6ca734b7f853652e`

See more details on using hashes here.

Provenance

The following attestation bundles were made for beyondtrust_bips_cli-0.14.3.tar.gz:

Publisher: promote.yml on BeyondTrust/ps-integration-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: beyondtrust_bips_cli-0.14.3.tar.gz
- Subject digest: f0d4898fb507cc7618d8a08544ae1009c39a22266692fdb3b39b8cd28497add8
- Sigstore transparency entry: 2669699976
- Sigstore integration time: Sep 1, 2026
Source repository:
- Permalink: BeyondTrust/ps-integration-cli@99d2bb563ad4c2f0f4a39325ceaf6bd69169fa6d
- Branch / Tag: refs/tags/v0.14.3
- Owner: https://github.com/BeyondTrust
- Access: private
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: promote.yml@99d2bb563ad4c2f0f4a39325ceaf6bd69169fa6d
- Trigger Event: release