# White Circle CLI (wcircle)
White Circle CLI is a thin wrapper over the White Circle API.
- Requires Python 3.13.7+
- Binary: `wcircle`
- Package: `whitecircle_cli`
## Features
- Profiles with XDG config: `${XDG_CONFIG_HOME:-~/.config}/wcircle/config.json`
- Env/flag precedence: CLI > env > saved profile
- Regions and endpoint override
- Auth via Bearer API key; `User-Agent: wcircle/<version>` and required API version header
- Robust HTTP client: timeouts, retries/backoff for 429/5xx, proxy support via env
- Output modes: human-readable (default) or `--json`
- Commands:
- `wcircle setup` — create/update profile; interactive prompts or `--non-interactive`
- `wcircle session get <session_id>` — fetch a session by internal id
- `wcircle check text "<message>"` — check text against all policies; prints `internal_id` and summary
- Exit codes:
- 0 success; for check: no violations
- 2 violations found (configurable)
- 64 invalid usage/config
- 69 service unavailable (network/5xx)
- 78 bad data (malformed request/response)
## Install
From source:
```bash
uv sync --dev
```
## Usage
```bash
wcircle --help
```
Environment variables:
- `WHITECIRCLE_PROFILE`
- `WHITECIRCLE_REGION`
- `WHITECIRCLE_API_TOKEN`
- `WHITECIRCLE_ENDPOINT`
Raw data
{
"_id": null,
"home_page": null,
"name": "whitecircle_cli",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.13.7",
"maintainer_email": null,
"keywords": "cli, whitecircle, security, policy",
"author": null,
"author_email": "White Circle <support@whitecircle.ai>",
"download_url": "https://files.pythonhosted.org/packages/1f/61/028456b9addfd4d9753f3a1cc283196a960e176077390ab6a0dd51d07ce0/whitecircle_cli-0.1.0.tar.gz",
"platform": null,
"description": "# White Circle CLI (wcircle)\n\nWhite Circle CLI is a thin wrapper over the White Circle API.\n\n- Requires Python 3.13.7+\n- Binary: `wcircle`\n- Package: `whitecircle_cli`\n\n## Features\n\n- Profiles with XDG config: `${XDG_CONFIG_HOME:-~/.config}/wcircle/config.json`\n- Env/flag precedence: CLI > env > saved profile\n- Regions and endpoint override\n- Auth via Bearer API key; `User-Agent: wcircle/<version>` and required API version header\n- Robust HTTP client: timeouts, retries/backoff for 429/5xx, proxy support via env\n- Output modes: human-readable (default) or `--json`\n- Commands:\n - `wcircle setup` \u2014 create/update profile; interactive prompts or `--non-interactive`\n - `wcircle session get <session_id>` \u2014 fetch a session by internal id\n - `wcircle check text \"<message>\"` \u2014 check text against all policies; prints `internal_id` and summary\n- Exit codes:\n - 0 success; for check: no violations\n - 2 violations found (configurable)\n - 64 invalid usage/config\n - 69 service unavailable (network/5xx)\n - 78 bad data (malformed request/response)\n\n## Install\n\nFrom source:\n\n```bash\nuv sync --dev\n```\n\n## Usage\n\n```bash\nwcircle --help\n```\n\nEnvironment variables:\n- `WHITECIRCLE_PROFILE`\n- `WHITECIRCLE_REGION`\n- `WHITECIRCLE_API_TOKEN`\n- `WHITECIRCLE_ENDPOINT`\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "White Circle CLI - thin wrapper over White Circle API",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://whitecircle.ai",
"Repository": "https://github.com/whitecircle/whitecircle_cli"
},
"split_keywords": [
"cli",
" whitecircle",
" security",
" policy"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "280ec842a22f7fed3227d0b94c382567311041e203f7c2e74b261b941cae1237",
"md5": "9b9fe8db532e1332ba44dcbbb1c1837a",
"sha256": "ae2edba5e54af057b912c5d1e98f27f41196aeb3e90e285859734fe0ccb24e11"
},
"downloads": -1,
"filename": "whitecircle_cli-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9b9fe8db532e1332ba44dcbbb1c1837a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.13.7",
"size": 14536,
"upload_time": "2025-09-04T07:38:03",
"upload_time_iso_8601": "2025-09-04T07:38:03.613241Z",
"url": "https://files.pythonhosted.org/packages/28/0e/c842a22f7fed3227d0b94c382567311041e203f7c2e74b261b941cae1237/whitecircle_cli-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "1f61028456b9addfd4d9753f3a1cc283196a960e176077390ab6a0dd51d07ce0",
"md5": "8d2d085e789e5543dd60964cd73c51c7",
"sha256": "1b16da7bb18a905c842442ebe31affa5ad55108194e77381ad9e0a1f9ea7bda4"
},
"downloads": -1,
"filename": "whitecircle_cli-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "8d2d085e789e5543dd60964cd73c51c7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.13.7",
"size": 10587,
"upload_time": "2025-09-04T07:38:05",
"upload_time_iso_8601": "2025-09-04T07:38:05.419548Z",
"url": "https://files.pythonhosted.org/packages/1f/61/028456b9addfd4d9753f3a1cc283196a960e176077390ab6a0dd51d07ce0/whitecircle_cli-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-04 07:38:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "whitecircle",
"github_project": "whitecircle_cli",
"github_not_found": true,
"lcname": "whitecircle_cli"
}
JSON
