unofficial cloudflared python wrapper
Project description
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.
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
pycloudflared-0.2.0.tar.gz
(5.6 kB
view details)
Built Distribution
File details
Details for the file pycloudflared-0.2.0.tar.gz
.
File metadata
- Download URL: pycloudflared-0.2.0.tar.gz
- Upload date:
- Size: 5.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: pdm/2.4.8 CPython/3.10.9
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1974d28c18457665f0af4e935335e9ec3e344562736e839d6857096450cf189e |
|
MD5 | 7bf2520b79df5cf7e42535817e6dac75 |
|
BLAKE2b-256 | 9b74d5e3aa48c9416bf8eb098aca2ebea8d9f05cad46939d0a686621fbca1f38 |
File details
Details for the file pycloudflared-0.2.0-py3-none-any.whl
.
File metadata
- Download URL: pycloudflared-0.2.0-py3-none-any.whl
- Upload date:
- Size: 7.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: pdm/2.4.8 CPython/3.10.9
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | e38100ef083f9b48bee0f5589899668176180cb7a7c73d8783f9793ab5d1cc15 |
|
MD5 | a9a8639b004b79156d3199000848ce43 |
|
BLAKE2b-256 | 60d719bc7c2a1eafe14c5b2be3c9c30f396a41e1b21c503e581b9305198ccd62 |