Skip to main content

Command line wallet tooling built on the pollyweb library.

Project description

pollyweb-cli

pollyweb-cli provides the pw command, a small wallet-style CLI built on top of the pollyweb Python package.

It helps you:

  • create a local PollyWeb key pair
  • bind that identity to a PollyWeb-enabled domain
  • send an echo request to a domain and verify the signed reply
  • send signed shell commands to a remote domain

Install

Install the CLI globally from PyPI with pipx:

pipx install pollyweb-cli

Or install it globally with pip:

python3 -m pip install pollyweb-cli

After installation, the CLI is available as:

pw --help

To confirm which release is installed:

pw --version

For more setup details, see docs/install.md.

Quick Start

Create your local key pair:

pw config

This writes your keys to:

  • ~/.pollyweb/private.pem
  • ~/.pollyweb/public.pem

Bind your wallet to a domain:

pw bind vault.example.com

This sends a signed Bind@Vault request to https://pw.vault.example.com/inbox using the compact public-key value in the request body. The bind request now relies on PollyWeb's optional message fields, so it omits explicit From and Schema values, and stores the returned bind token in ~/.pollyweb/binds.yaml. Rebinding the same domain replaces the existing bind for that domain unless the server returns a different Schema, in which case both entries are kept.

Open an interactive shell against a domain:

pw shell vault.example.com

Send a one-shot echo request and verify the synchronous signed response:

pw echo vault.example.com

This sends a signed Echo@Domain message to https://pw.<domain>/inbox, expects a synchronous PollyWeb message in return, verifies the reply signature using the responding domain's DKIM key, and checks that the response From, To, Subject, and Correlation values match the target domain and the original request.

Each command you enter is parsed into a base Command plus an Arguments dictionary, then sent as a signed Shell@Domain message whose From header is set to the first stored bind for that domain. Long flags like --all 123 become {"all":"123"}, short flags like -a 123 become {"a":"123"}, key=value tokens like a=123 become {"a":"123"}, and plain positional arguments remain indexed as {"0":"value"}. pw shell also keeps the last 20 commands for that exact domain in ~/.pollyweb/history/, so you can use the up/down arrows to revisit recent commands. Commands are recorded before the network request is sent, which means failed requests still appear in that domain's history.

To inspect the signed shell request and response for each command as colorized, indented YAML, including the full inbox URL the POST is sent to:

pw shell --debug vault.example.com

Debugging Bind Requests

Use --debug with pw bind to print the outbound request payload, the full inbox URL the POST is sent to, and the inbound response body as colorized, indented YAML:

pw bind --debug vault.example.com

This is useful when you want to inspect the exact message contents being sent or troubleshoot an unexpected server response.

Command Summary

  • pw config generates a PollyWeb key pair in ~/.pollyweb
  • pw config --force replaces an existing key pair
  • pw bind <domain> requests and stores a bind token for a domain
  • pw bind --debug <domain> shows the target inbox URL plus bind request and response payloads as colorized YAML
  • pw echo <domain> sends Echo@Domain and verifies the signed synchronous response
  • pw echo --debug <domain> shows the target inbox URL plus echo request and response payloads as colorized YAML
  • pw shell <domain> starts an interactive remote shell session
  • pw shell <domain> remembers the last 20 commands per domain for arrow-key navigation
  • pw shell --debug <domain> shows the target inbox URL plus shell request and response payloads as colorized YAML
  • pw --version prints the installed CLI version

For more examples and command behavior, see docs/usage.md.

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

pollyweb_cli-0.1.25.tar.gz (19.5 kB view details)

Uploaded Source

Built Distribution

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

pollyweb_cli-0.1.25-py3-none-any.whl (10.5 kB view details)

Uploaded Python 3

File details

Details for the file pollyweb_cli-0.1.25.tar.gz.

File metadata

  • Download URL: pollyweb_cli-0.1.25.tar.gz
  • Upload date:
  • Size: 19.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pollyweb_cli-0.1.25.tar.gz
Algorithm Hash digest
SHA256 6491ba3989dd2fc799bd60fee54600fed8fa8ef68c096e83c5ac691408fc69f7
MD5 3aa731d589010f2784f6c1aed211f8de
BLAKE2b-256 bbc5921612db6f117cd3101b2a674aac01d4f4f1e64dc57ef60aa9950ce59e79

See more details on using hashes here.

Provenance

The following attestation bundles were made for pollyweb_cli-0.1.25.tar.gz:

Publisher: publish.yml on pollycore/wallet-cli

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

File details

Details for the file pollyweb_cli-0.1.25-py3-none-any.whl.

File metadata

  • Download URL: pollyweb_cli-0.1.25-py3-none-any.whl
  • Upload date:
  • Size: 10.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pollyweb_cli-0.1.25-py3-none-any.whl
Algorithm Hash digest
SHA256 4109a0635ccf2dcadb4637e16490ba233d324d9f452868adc9c37d215bacad68
MD5 fb5ac7d5e7a3b30b56d557046015e074
BLAKE2b-256 4bd159c487cd260ec7fad41caac83a0f099f70d5b97a724534b25bef6d2b58b2

See more details on using hashes here.

Provenance

The following attestation bundles were made for pollyweb_cli-0.1.25-py3-none-any.whl:

Publisher: publish.yml on pollycore/wallet-cli

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