Skip to main content

PyWeb CLI

PyPI Python

PyWeb — The Python Alternative Web. Register FREE TLDs, host on Hugging Face or your own hardware.

pyweb-cli is the official command-line tool for PyWeb. It lets you:

  • Register custom top-level domains (e.g. .mybrand) for free.
  • Deploy static sites, landing pages, or simple blogs to the PyWeb network.
  • Run a local development server with live reload.
  • Manage your domains and deployments from an interactive TUI.

Install

pip install pyweb-cli

Optional extras:

# Interactive TUI
pip install pyweb-cli[tui]

# Live reload with file-system events
pip install pyweb-cli[watch]

# Everything
pip install pyweb-cli[all]

Quick start

# Log in (just a username today; API tokens are optional)
pyweb login mycoolname

# Create a new PyWeb project
pyweb init my-landing-page --template landing

# Move into the project
cd my-landing-page

# Register a free TLD
pyweb create domain .mycoolname

# Deploy it
pyweb deploy

# Open it in your browser
pyweb open .mycoolname

Commands

Command Description
pyweb init <name> Create a new PyWeb project from a template.
pyweb login <username> Store your PyWeb username (and optional API token).
pyweb whoami Show the current user.
pyweb create domain .tld Register a free TLD.
pyweb site link --tld .tld Link the current project to a TLD.
pyweb deploy [--tld .tld] Deploy the current project.
pyweb serve [--port 8080] [--watch] Local preview server.
pyweb open .tld Open the live URL.
pyweb list List your registered domains.
pyweb status --tld .tld Show domain status and last deploy.
pyweb logs --tld .tld Show deployment logs.
pyweb tui Interactive terminal UI.

Configuration

Global config lives in ~/.pyweb/config.json. Project config lives in pyweb.json next to index.html.

Example pyweb.json:

{
  "name": "my-landing-page",
  "tld": ".mycoolname",
  "template": "landing",
  "visibility": "public"
}

Environment variables:

  • PYWEB_API_BASE — override the default API endpoint.
  • PYWEB_TOKEN — override the stored API token.

License

MIT — see LICENSE.

Release files for pyweb-cli 4.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pyweb-cli 4.0.0
File Size Uploaded
pyweb_cli-4.0.0.tar.gz 16.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for pyweb-cli 4.0.0
File Interpreter ABI Platform
pyweb_cli-4.0.0-py3-none-any.whl Python 3 none any Details

Total release size: 40.4 kB

Release files / pyweb_cli-4.0.0.tar.gz

Download URL pyweb_cli-4.0.0.tar.gz
Size 16.4 kB
Tags Source
SHA-256 checksum
How to use checksums
5aad167bbc7edbd72a920685a59de7ba27baa64dcc90c6a6db3c1d3e2592be52
BLAKE2b-256 checksum
How to use checksums
e800b8ebc59ab9ad46d968ed67950a54b2c08171255a4c6fe390277581718ac8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.12

Release files / pyweb_cli-4.0.0-py3-none-any.whl

Download URL pyweb_cli-4.0.0-py3-none-any.whl
Size 23.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4c04b2e67b8ca1838f8e4a161feaefe2855b025363fd9a9cc0b99b93e3ac0b89
BLAKE2b-256 checksum
How to use checksums
a1adfd28aa4fba2a55c394d115a42e2e4fdf9be435dcb6c889ee6773d5bcb6a4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.12

Release history Release notifications | RSS feed

This release

4.0.0 This release

2 release files

3.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page