Skip to main content

Command-line client for Tripwire canaries

Project description

tripwire-cli

Command-line client for Tripwire canaries. Installs a single tripwire command.

Install

uv tool install --from . tripwire-cli

Or run without installing:

uvx --from . tripwire --help

Usage

# Log in and cache a token. Defaults to passwordless email-code login: it
# prompts for your email (defaulting to `git config user.email`) and the
# 6-digit code emailed to you. Operators can pass --user-id / --password to use
# the user-id + password login instead.
tripwire login

# Create a canary. The credential is returned once, in this response, so
# capture it now. Provider-minted types (aws/anthropic/github) can take ~2 min;
# the CLI waits and prints a progress note while it provisions.
tripwire canaries create --type dns_label --memo "env metrics host"
tripwire canaries create --type aws_access_key --memo "warehouse reporting key"

# Inspect what you own (summaries only; the credential is never shown again).
tripwire canaries list
tripwire canaries get can_1234abcd

# Wind one down.
tripwire canaries deactivate can_1234abcd
tripwire canaries delete can_1234abcd

canaries subcommands print JSON to stdout (pipe to jq); progress and other plain-text messages go to stderr, so stdout stays clean JSON. Run tripwire --help for the full reference.

Supported create types are dns_label, aws_access_key, anthropic_api_key, and github_pat.

canaries create accepts --timeout <seconds> (env TRIPWIRE_CREATE_TIMEOUT, default 240) for the per-request read timeout; it must stay above the server's ~180s provisioning wait so the one-time credential reveal is never lost to a premature client timeout.

Server

login talks to https://tripwire.so/api/v1 by default. Set TRIPWIRE_SERVER to point at a self-hosted or test server before logging in; the server is bound to your token at login time. The token is cached at ~/.config/tripwire/credentials.json (honoring XDG_CONFIG_HOME).

Project details


Download files

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

Source Distribution

tripwire_cli-0.2.0.tar.gz (18.0 kB view details)

Uploaded Source

Built Distribution

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

tripwire_cli-0.2.0-py3-none-any.whl (10.2 kB view details)

Uploaded Python 3

File details

Details for the file tripwire_cli-0.2.0.tar.gz.

File metadata

  • Download URL: tripwire_cli-0.2.0.tar.gz
  • Upload date:
  • Size: 18.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.5

File hashes

Hashes for tripwire_cli-0.2.0.tar.gz
Algorithm Hash digest
SHA256 f6f1a0e64ae9fa70268e4df4fc4070736d280b5c858ef6f3a0e56c89aa3d4f9c
MD5 e7cd85f47872315c063e4f3d56c06a15
BLAKE2b-256 1cf55421d3825f8d5d0e6fbfb74f3245f509888953d5db7c948e066b8eae3535

See more details on using hashes here.

File details

Details for the file tripwire_cli-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for tripwire_cli-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 70d68c6e765b55fa14debe5a84b8789711a945eb312b63f05c67deff3b9d4906
MD5 08f9d21941e58e19951c1344b0989dcc
BLAKE2b-256 c195aa50a7fe613fd908121ed95f7b8296d5a8729b408c4bf508422e43740ada

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page