pycloudflared
python cloudflared wrapper
Install
pip install pycloudflared
Cloudflare binaries will be downloaded the first time you run it.
Usage
❯ pycloudflared --help
NAME:
cloudflared - Cloudflare's command-line tool and agent
USAGE:
cloudflared [global options] [command] [command options]
VERSION:
2023.2.1 (built 2023-02-03-1038 UTC)
DESCRIPTION:
cloudflared connects your machine or user identity to Cloudflare's global network.
You can use it to authenticate a session to reach an API behind Access, route web traffic to this machine,
and configure access control.
See https://developers.cloudflare.com/cloudflare-one/connections/connect-apps for more in-depth documentation.
COMMANDS:
update Update the agent if a new version exists
version Print the version
proxy-dns Run a DNS over HTTPS proxy server.
service Manages the cloudflared Windows service
help, h Shows a list of commands or help for one command
Access:
access, forward access <subcommand>
Tunnel:
tunnel Use Cloudflare Tunnel to expose private services to the Internet or to Cloudflare connected private users.
GLOBAL OPTIONS:
--credentials-file value, --cred-file value Filepath at which to read/write the tunnel credentials [%TUNNEL_CRED_FILE%]
--region value Cloudflare Edge region to connect to. Omit or set to empty to connect to the global region. [%TUNNEL_REGION%]
--edge-ip-version value Cloudflare Edge ip address version to connect with. {4, 6, auto} (default: "4") [%TUNNEL_EDGE_IP_VERSION%]
--post-quantum, --pq When given creates an experimental post-quantum secure tunnel (default: false) [%TUNNEL_POST_QUANTUM%]
--overwrite-dns, -f Overwrites existing DNS records with this hostname (default: false) [%TUNNEL_FORCE_PROVISIONING_DNS%]
--help, -h show help (default: false)
--version, -v, -V Print the version (default: false)
COPYRIGHT:
(c) 2023 Cloudflare Inc.
Your installation of cloudflared software constitutes a symbol of your signature indicating that you accept
the terms of the Apache License Version 2.0 (https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/license),
Terms (https://www.cloudflare.com/terms/) and Privacy Policy (https://www.cloudflare.com/privacypolicy/).
All arguments are passed directly to cloudflared.
Since there is no binary for arm mac, you may need Rosetta 2.
try_cloudflared
from pycloudflared import try_cloudflare
try_cloudflare(port=7860)
A simple function to run trycloudflare within python.
Metadata
Release files for pycloudflared 0.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| pycloudflared-0.3.0.tar.gz | 4.7 kB | Without provenance | Details for pycloudflared-0.3.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| pycloudflared-0.3.0-py3-none-any.whl | Python 3 | none | any | Details for pycloudflared-0.3.0-py3-none-any.whl |
Total release size: 11.4 kB
Release files / pycloudflared-0.3.0.tar.gz
| Download URL | pycloudflared-0.3.0.tar.gz |
|---|---|
| Size | 4.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d2df5c91715c0b0446e6cb03daf147f05e7d68f40d1c6147d8bee70d23d7038c
|
|
BLAKE2b-256 checksum How to use checksums |
f4bef5007de781eb463572fac429ad573abf66d62439703efa0ddc68b80d0d92
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.9.12 {"installer":{"name":"uv","version":"0.9.12"},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
Release files / pycloudflared-0.3.0-py3-none-any.whl
| Download URL | pycloudflared-0.3.0-py3-none-any.whl |
|---|---|
| Size | 6.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2eaefd006849eaa2af6301eb2b7c7a6f71482b89477a59c01e2f643a9a9fb24b
|
|
BLAKE2b-256 checksum How to use checksums |
8f598536f293fee58ccd07bb81160eee9329ebeef7b03e9c05ea8a100f2c207c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.9.12 {"installer":{"name":"uv","version":"0.9.12"},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
Security for pycloudflared 0.3.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.