Skip to main content

Opbeat CLI

Command line client for Opbeat.

https://badge.fury.io/py/opbeatcli.png https://secure.travis-ci.org/opbeat/opbeatcli.png?branch=dev

Installation

Make sure you have Git and a supported version Python installed on your system. The supported Python versions are: 2.6.x, 2.7.x, 3.3+ and PyPy.

$ python --version

Opbeat CLI can then be installed using the standard Python package installation method:

$ pip install opbeatcli

If pip is not available, you can alternatively use easy_install:

$ easy_install opbeatcli

To verify successful installation of Opbeat CLI:

$ opbeat --version

Usage

$ opbeat [common options] sub-command [sub-command options]

Common Options

These options are shared by all sub-commands.

To obtain these, please go to your app settings on opbeat.com:

--org-id, -o

Organization ID

--app-id, -a

Application ID.

--secret-token, -t

Secret API authentication token.

For more information and a complete list of the available common options, please see the command help:

$ opbeat --help

Sub-Commands

deployment

This command registers a deployment of an application to a machine with the Opbeat API. Deployment tracking enables advanced features of the Opbeat platform, such as version history and the ability to relate errors with particular deployments, etc. It is meant to be run from the machine that is being deployed to:

# A basic deployment registration: Run this from your application
# repository directory on the machine which it's been deployed to:
$ opbeat -o ORGANISATION_ID -a APP_ID -t SECRET_TOKEN \
    deployment --component path:.

For more information and examples please see deployment tracking documentation and the command help:

$ opbeat deployment --help

Metadata

Release files for opbeatcli 2.0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for opbeatcli 2.0.2
File Size Uploaded Provenance Actions
opbeatcli-2.0.2.tar.gz 21.7 kB Without provenance Details for opbeatcli-2.0.2.tar.gz

Release files / opbeatcli-2.0.2.tar.gz

Download URL opbeatcli-2.0.2.tar.gz
Size 21.7 kB
Tags Source
SHA-256 checksum
How to use checksums
5002e2da2a1ae10ef9249495c0c6bc0f0d823e85d022bc64bd48409c816cd0ef
BLAKE2b-256 checksum
How to use checksums
3e7a84abc164a73729692000b6c31b8902c6b66564d46cb839d7415039e3226f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for opbeatcli 2.0.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page