Skip to main content

White Circle CLI - thin wrapper over White Circle API

Project description

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:

uv sync --dev

Usage

wcircle --help

Environment variables:

  • WHITECIRCLE_PROFILE
  • WHITECIRCLE_REGION
  • WHITECIRCLE_API_TOKEN
  • WHITECIRCLE_ENDPOINT

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

whitecircle_cli-0.1.1.tar.gz (10.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

whitecircle_cli-0.1.1-py3-none-any.whl (14.5 kB view details)

Uploaded Python 3

File details

Details for the file whitecircle_cli-0.1.1.tar.gz.

File metadata

  • Download URL: whitecircle_cli-0.1.1.tar.gz
  • Upload date:
  • Size: 10.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.8

File hashes

Hashes for whitecircle_cli-0.1.1.tar.gz
Algorithm Hash digest
SHA256 caa0198888c8dba33bed804b5f9eac3ee53f5ecc606e9f488eb414ee17d49dcc
MD5 333ba9aa6be585493cfe41518d28aab5
BLAKE2b-256 cd9ecaf666119ac854f2ba60d192c5c15fa1abddbe7c47a07d7b01d02f323e6b

See more details on using hashes here.

File details

Details for the file whitecircle_cli-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for whitecircle_cli-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 450ccffe58e9a1ddc815f82f369ca04567b695c188a46f438f663461a9f15198
MD5 fa1b0b9fb6284e1c30f22d39edb817bc
BLAKE2b-256 98d7d4103f44ffe0fc03da706c72e1dd60bf6dc7fb36e9e83a0fe996e41d1c9d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page