Skip to main content

pwpush CLI

Build status Python Version PyPI Code style: black License

The elegant way to share secrets from the command line.
Self-destructing links for passwords, files, requests, and sensitive data.

InstallationQuick StartFeaturesDocumentation


What is pwpush?

pwpush is a beautiful, intuitive CLI for Password Pusher — the secure way to share passwords, secrets, and files. Instead of sending sensitive data over email or Slack, create self-destructing links that automatically expire after a set number of views or days.

# Share a password securely
$ pwpush push --secret "my-sensitive-payload"
The secret has been pushed to:
https://us.pwpush.com/p/abc123xyz

# Or pipe in content from a file or command
$ cat secret.txt | pwpush push
The secret has been pushed to:
https://us.pwpush.com/p/xyz789abc

Installation

pip install pwpush

Requires Python 3.10 or higher.


Quick Start

1. Run the Config Wizard 🧙

The easiest way to get started. The wizard guides you through selecting your instance, setting up authentication, and configuring defaults:

$ pwpush config wizard

Password Pusher CLI Setup
This wizard will create your local pwpush configuration.

┏━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ Option  Instance               Description             ┃
┡━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ 1       https://eu.pwpush.com  EU hosted: Pro features │
│ 2       https://us.pwpush.com  US hosted: Pro features │
│ 3       https://oss.pwpush.com│ OSS: EU Data Residency  │
│ 4       Custom                 Self-hosted instance    │
└────────┴───────────────────────┴─────────────────────────┘

2. Push Your First Secret

# Interactive mode — just type and go
$ pwpush push
Enter secret: ********
The secret has been pushed to:
https://pwpush.com/p/xyz789abc

# Or pass it directly
$ pwpush push --secret "my-password" --days 3 --views 5

# Auto-generate a secure password
$ pwpush push --auto
Passphrase is: battery horse staple correct
https://pwpush.com/p/auto123gen

3. Share Files

$ pwpush push-file secret-document.pdf --days 7
https://pwpush.com/f/file456token

4. Request Secrets (Pro)

Ask others to send you secrets securely with the request command. Perfect for when you need someone to send you credentials, files, or any sensitive data:

$ pwpush request "Please send me the production API key" --notify "devops@company.com"
Request created successfully:
https://pwpush.com/r/abc123xyz

# With a file attachment
$ pwpush request "Send me the signed NDA" --attach-file ./nda-template.pdf --notify "legal@partner.com"
Request created successfully:
https://pwpush.com/r/def456uvw

Note: Requests require authentication with a Password Pusher Pro/Enterprise instance (API v2.1+).


Why pwpush?

🔐 Security First

  • Zero permanent storage — data is encrypted and auto-deleted
  • Full audit trails — see exactly who accessed what and when
  • Requests — ask others to send you secrets securely (Pro)
  • Prevent URL scanners with --retrieval-step

✨ Developer Experience

  • Auto-negotiating API — seamlessly works with v2 and legacy instances
  • Beautiful output — rich tables, colors, and formatting
  • JSON mode — perfect for scripts and CI/CD pipelines

🌍 Multi-Instance Support

Works with hosted services or your own instance:

  • eu.pwpush.com — EU-hosted Pro
  • us.pwpush.com — US-hosted Pro
  • oss.pwpush.com — Free OSS tier
  • Self-hosted — Your own domain

Everyday Commands

# Quick password share
pwpush push --secret "db-password" --days 1 --views 3

# Share a link as a clickable URL
pwpush push --secret "https://staging.example.com" --kind url

# Push with a reference note (for your records)
pwpush push --secret "password" --note "AWS Root - Production"

# Request a secret from someone (Pro feature)
pwpush request "Send me the production API key" --notify "devops@company.com"

# Request with file attachment (Pro feature)
pwpush request "Send me the signed contract" --attach-file ./template.pdf --notify "vendor@example.com"

# List your active pushes
pwpush list

# View audit trail
pwpush audit <url_token>

# Expire a push immediately
pwpush expire <url_token>

Pro Features

For Password Pusher Pro users with authenticated access:

# Email notifications when push is accessed
pwpush push --secret "password" --notify "admin@company.com"

# Multi-language notifications
pwpush push --secret "password" --notify "admin@company.com" --notify-locale "es"

# Create a request for someone to send you a secret (requires API v2.1+ commercial edition)
pwpush request "Send me the production database password" --notify "colleague@example.com"

# Request with content from a file
pwpush request --content ./instructions.txt --notify "team@example.com"

# Request with file attachment
pwpush request "Send me the signed contract" --attach-file ./template.pdf --notify "vendor@example.com"

# Multiple accounts per API token (automatically detected)

Note: The request command requires authentication with a Password Pusher Pro or Enterprise instance running API v2.1 or greater.


Configuration

The CLI stores settings in ~/.config/pwpush/config.ini with restricted permissions (0o600):

# Guided setup (recommended)
pwpush config wizard

# View current settings
pwpush config

# Quick updates
pwpush config set expire_after_days 7
pwpush config set expire_after_views 10

# Reset everything
pwpush config delete

Advanced Usage

JSON Output for Scripting

# Perfect for automation
$ pwpush --json push --secret "password"
{"url":"https://eu.pwpush.com/p/abc123","url_token":"abc123","expire_after_days":7}

# Chain with other tools
$ pwpush --json push --auto | jq -r '.url' | pbcopy

Pipe Input

# Pipe passwords directly
cat secret.txt | pwpush push

# From environment variables
pwpush push --secret "$DATABASE_PASSWORD"

Debug Mode

# Troubleshoot connectivity
pwpush --debug push --secret "test"

API Compatibility

The CLI automatically detects your instance's API version:

  1. Probes GET /api/v2/version on first run
  2. Uses API v2 if available (modern, feature-rich)
  3. Falls back to legacy endpoints for older instances
  4. Caches the result for 1 hour to avoid repeated probes

Works with:

  • ✅ Password Pusher Pro (any version)
  • ✅ Open Source v2.4.2+ with API v2
  • ✅ Older instances via legacy fallback

Security Notes

  • All data is encrypted in transit (HTTPS) and at rest
  • Content is permanently deleted after expiration
  • API tokens are stored with 0o600 permissions
  • Use --retrieval-step to prevent bot consumption
  • Passphrase protection available with --passphrase

Links & Resources

Resource Link
📖 Full Documentation docs.pwpush.com
🌐 Password Pusher pwpush.com
💻 Open Source Project github.com/pglombardo/PasswordPusher
🐛 Issue Tracker github.com/pglombardo/pwpush-cli/issues

About

Built by Apnotic — empowering secure information distribution.

Download files

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

Source Distribution

pwpush-0.16.6.tar.gz (34.9 kB view details)

Uploaded Source

Built Distribution

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

pwpush-0.16.6-py3-none-any.whl (40.9 kB view details)

Uploaded Python 3

File details

Details for the file pwpush-0.16.6.tar.gz.

File metadata

  • Download URL: pwpush-0.16.6.tar.gz
  • Upload date:
  • Size: 34.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.4.1 CPython/3.14.6 Linux/7.0.0-22-generic

File hashes

Hashes for pwpush-0.16.6.tar.gz
Algorithm Hash digest
SHA256 6badcd1a33529f45b721fca89fff3d7bf4c7ebd1ed36b6b9266d12f7f5426a68
MD5 ac964b79ac8e91b9fc31602ebe0e57a2
BLAKE2b-256 146aaf45dc1b15479ba84512c0b6e8da158a0de68aeeb24d22db5d6791f2cea2

See more details on using hashes here.

File details

Details for the file pwpush-0.16.6-py3-none-any.whl.

File metadata

  • Download URL: pwpush-0.16.6-py3-none-any.whl
  • Upload date:
  • Size: 40.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.4.1 CPython/3.14.6 Linux/7.0.0-22-generic

File hashes

Hashes for pwpush-0.16.6-py3-none-any.whl
Algorithm Hash digest
SHA256 4f843066f763a384ed755f98d6e08cf87dedb4a8da74a9f58883acdd2a8cebea
MD5 507279da72fa400776f2cfd9993fd36c
BLAKE2b-256 12dde15e1a0bed102fe84a294706c6fd5dfa035d273966462a9353f5ace6946d

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 Sentry Error logging StatusPage Status page