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, github_pat, web_login_credential, browser_session_cookie, postgres_login, and kubernetes_kubeconfig. The request-path types (web_login_credential, browser_session_cookie, postgres_login, kubernetes_kubeconfig) inline their artifact fields directly in the create response.

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.3.0.tar.gz (21.1 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.3.0-py3-none-any.whl (11.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for tripwire_cli-0.3.0.tar.gz
Algorithm Hash digest
SHA256 654bbe9cb11ec5d31446cec869e80b6941363009c80341bf2a965854de804e32
MD5 f286699bf29a5c415c0d203037464ca2
BLAKE2b-256 b9a68b9e6328815cb38ea272575846240c9a2bd25edcbd66f5c63e6f8ecdf4e0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for tripwire_cli-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f42659d3da66782b1d220dbcc589ff23f8c23bcd1d952c27f7999d0ca8078a83
MD5 02fabbe97926a64a7f0a33edb292f05f
BLAKE2b-256 570971ea77c70ad3054dd7a0a870f61dde92feca20e3c127da9a0af95d1eb9b5

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