Skip to main content

Ghostbit CLI — create end-to-end encrypted pastes from the terminal

Project description

Ghostbit CLI

Command-line tool for Ghostbit — a self-hosted, end-to-end encrypted paste service.

All content is encrypted in the client before being sent to the server. The server never sees your plaintext.

Install

pip install ghostbit-cli

With syntax highlighting and Markdown rendering:

pip install "ghostbit-cli[all]"       # pygments + rich
pip install "ghostbit-cli[color]"     # pygments only (syntax highlighting)
pip install "ghostbit-cli[markdown]"  # rich only (Markdown rendering)

Usage

# Paste from stdin
cat file.py | gbit

# Paste a file (language auto-detected from extension)
gbit file.py

# With options
gbit file.py --lang python --burn --expires 3600

# Password-protected paste (prompted securely)
echo "secret" | gbit -p

# Or pass inline (visible in process list)
gbit file.py --password mysecret

# View and decrypt a paste in the terminal
gbit view https://paste.example.com/abc123#KEY~TOKEN

# View a password-protected paste (prompts for password)
gbit view https://paste.example.com/abc123#~TOKEN

# Output JSON (includes full URL with decryption key)
cat data.json | gbit --json

# Point to your self-hosted instance
gbit config set server https://paste.example.com

Options

Flag Short Description
--lang -l Language hint (python, go, rust, …)
--expires -e TTL in seconds (3600 = 1h, 86400 = 1d)
--burn -b Delete after the first view
--max-views -m Delete after N views
--password -p Encrypt with a password (prompted if no value given)
--server -s Override server URL for this call
--quiet -q Print URL only
--json Print full JSON response
--no-history Don't save to local history
--version -V Print version and exit

Configuration

gbit config set server https://paste.example.com
gbit config show
gbit config unset server

Config is stored at ~/.config/ghostbit.toml.

Security Note

The local history (~/.local/share/ghostbit/history.jsonl) stores full URLs including decryption keys. Use --no-history for sensitive pastes, or clear history with gbit list --clear.

Self-hosting

See the Ghostbit server repository for Docker and manual setup instructions.

License

MIT

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

ghostbit_cli-1.2.0.tar.gz (11.7 kB view details)

Uploaded Source

Built Distribution

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

ghostbit_cli-1.2.0-py3-none-any.whl (10.9 kB view details)

Uploaded Python 3

File details

Details for the file ghostbit_cli-1.2.0.tar.gz.

File metadata

  • Download URL: ghostbit_cli-1.2.0.tar.gz
  • Upload date:
  • Size: 11.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for ghostbit_cli-1.2.0.tar.gz
Algorithm Hash digest
SHA256 94c358299a42b154935e1a6c61ec5cd40dc2109de39c2667b8ffffc7fa1b0df6
MD5 f2a77992104194040ef7f69fe7e27c48
BLAKE2b-256 b64aa2a0f1333e188dfc569d3cbbd3e4d98cc58b5890704aa41f6e088c46d04b

See more details on using hashes here.

Provenance

The following attestation bundles were made for ghostbit_cli-1.2.0.tar.gz:

Publisher: release.yml on stackopshq/ghostbit

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

File details

Details for the file ghostbit_cli-1.2.0-py3-none-any.whl.

File metadata

  • Download URL: ghostbit_cli-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 10.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for ghostbit_cli-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c2bb3d0037826c27dbaefdf562e0ac6f72d730caebdf6326aa6e865c4cb65781
MD5 01e0c7cb26198499c0f42b452d20d8cf
BLAKE2b-256 b551e31d4a151c20565b9129ee1a7ddc086d73878574e6b3db807a1edc540027

See more details on using hashes here.

Provenance

The following attestation bundles were made for ghostbit_cli-1.2.0-py3-none-any.whl:

Publisher: release.yml on stackopshq/ghostbit

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

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