# clickflare
[](https://pypi.org/project/clickflare/)
[](https://github.com/IotaSpencer/clickflare/actions/workflows/python-publish.yml)
A command line tool for interacting with Cloudflare's API.
## Installation
(This should be able to be ran with pipx as long as you have a config file set up. See [the Configuration section](#Configuration) for more information.)
#### With pipx
`pipx run clickflare [options/commands]`
#### Otherwise
`pip install clickflare`
## Configuration
#### In the file `~/.clickflare/config` (create it if it doesn't exist)
```toml
[cf-api]
token = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
```
Obviously replace XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX with your API token.
## Usage
```bash
clickflare [options] [commands]
```
Some commands will prompt for input if it is not provided. (e.g. `clickflare zones dns_records add`)
Raw data
{
"_id": null,
"home_page": null,
"name": "clickflare",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "IotaSpencer <me@iotaspencer.me>",
"keywords": "cli, cloudflare, python",
"author": null,
"author_email": "IotaSpencer <me@iotaspencer.me>",
"download_url": "https://files.pythonhosted.org/packages/65/94/710d9a77f7c1936369b59da8a800c0e7e015d7cc59445f08893c30584b9e/clickflare-0.0.5.tar.gz",
"platform": null,
"description": "# clickflare\n\n[](https://pypi.org/project/clickflare/)\n[](https://github.com/IotaSpencer/clickflare/actions/workflows/python-publish.yml)\n\nA command line tool for interacting with Cloudflare's API.\n\n\n## Installation\n\n(This should be able to be ran with pipx as long as you have a config file set up. See [the Configuration section](#Configuration) for more information.)\n\n\n\n#### With pipx\n\n`pipx run clickflare [options/commands]`\n\n#### Otherwise\n\n`pip install clickflare`\n\n## Configuration\n\n#### In the file `~/.clickflare/config` (create it if it doesn't exist)\n```toml\n[cf-api]\ntoken = \"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\"\n```\nObviously replace XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX with your API token.\n\n## Usage\n\n```bash\nclickflare [options] [commands]\n```\n\nSome commands will prompt for input if it is not provided. (e.g. `clickflare zones dns_records add`)",
"bugtrack_url": null,
"license": null,
"summary": "A command line interface for Cloudflare",
"version": "0.0.5",
"project_urls": {
"Homepage": "https://github.com/IotaSpencer/clickflare",
"Issues": "https://github.com/IotaSpencer/clickflare/issues"
},
"split_keywords": [
"cli",
" cloudflare",
" python"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "40065072fb68ff3d50b30063b9d3d1f94fc1de699e53da45eca831f1b7bc2957",
"md5": "4226f368bcd90ab56d1f87a12e58aad3",
"sha256": "f4150e7ba6add306daeb5835bfe87ff5e708ee2f01ff3514f119544ebec73b17"
},
"downloads": -1,
"filename": "clickflare-0.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4226f368bcd90ab56d1f87a12e58aad3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 25924,
"upload_time": "2025-01-25T10:20:04",
"upload_time_iso_8601": "2025-01-25T10:20:04.134613Z",
"url": "https://files.pythonhosted.org/packages/40/06/5072fb68ff3d50b30063b9d3d1f94fc1de699e53da45eca831f1b7bc2957/clickflare-0.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "6594710d9a77f7c1936369b59da8a800c0e7e015d7cc59445f08893c30584b9e",
"md5": "86604cabcd1c3dd36c1e1e346ddb2f90",
"sha256": "07942615c05d4238f98cf4e9eef6ed149bb477de50759394ef6d1044de1fc89b"
},
"downloads": -1,
"filename": "clickflare-0.0.5.tar.gz",
"has_sig": false,
"md5_digest": "86604cabcd1c3dd36c1e1e346ddb2f90",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 21425,
"upload_time": "2025-01-25T10:20:05",
"upload_time_iso_8601": "2025-01-25T10:20:05.840238Z",
"url": "https://files.pythonhosted.org/packages/65/94/710d9a77f7c1936369b59da8a800c0e7e015d7cc59445f08893c30584b9e/clickflare-0.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-25 10:20:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "IotaSpencer",
"github_project": "clickflare",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "click",
"specs": [
[
"==",
"8.1.8"
]
]
},
{
"name": "cloudflare",
"specs": [
[
"==",
"4.0.0"
]
]
},
{
"name": "terminaltables",
"specs": [
[
"==",
"3.1.10"
]
]
},
{
"name": "toml",
"specs": [
[
"==",
"0.10.2"
]
]
}
],
"lcname": "clickflare"
}
JSON
