Skip to main content

A terminal-first CLI tool that scans iOS, Android, and Web projects for launch-critical compliance risks.

Project description

Oncecheck CLI

A terminal-first CLI tool that scans iOS, Android, and Web projects for launch-critical compliance risks.

Features

  • 73+ compliance rules across iOS, Android, Web, and cross-platform categories
  • Auto-detection — identifies your project type automatically
  • Interactive browser — arrow-key driven UI to explore findings
  • Multiple export formats — JSON, SARIF 2.1, plain text
  • CI/CD ready — exit codes: 0 (pass), 1 (warnings), 2 (failures)
  • Cross-platform checks — COPPA, HIPAA, PCI-DSS, accessibility, supply chain
  • Rule suppression.oncecheckignore file and .oncecheckrc config
  • Shell completions — bash, zsh, and fish

Rule Categories

Platform Rules Covers
iOS 20 Info.plist, ATS, entitlements, privacy manifests, HealthKit, Keychain
Android 18 AndroidManifest, target SDK, permissions, ProGuard, Play Integrity
Web 27 CSP, CORS, OWASP Top 10, accessibility, privacy, cookies
Common 8 COPPA, HIPAA, PCI-DSS, color contrast, data retention, supply chain

Installation

pip install oncecheck

Development

git clone <repo-url>
cd oncecheck-cli
python -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"

Usage

Interactive mode

oncecheck

Launches the full interactive UI with welcome screen, menu navigation, and findings browser.

Direct scan

# Auto-detect platform
oncecheck scan ./my-project

# Force a specific platform
oncecheck scan ./my-project --platform ios

# Show explicit scan pipeline step states (sync/auth/quota/detect/scan/report)
oncecheck scan ./my-project

# Live-sync official policy pages before scanning
oncecheck scan ./my-project --policy-sync auto

# Hard-fail scan if policy sources are stale/missing
oncecheck scan ./my-project --require-fresh-policies

# Export as JSON (Team plan)
oncecheck scan ./my-project --format json --output results.json

# Export as SARIF (Team plan — for GitHub/VS Code)
oncecheck scan ./my-project --format sarif --output results.sarif

# Interactive findings browser
oncecheck scan ./my-project --interactive

# Fail CI on warnings or higher
oncecheck scan ./my-project --fail-on WARN

Policy Source Sync

# Sync official policy sources (Apple/Google/OWASP/W3C)
oncecheck rules sync

# Force a full refresh of all policy source snapshots
oncecheck rules sync --force

# Check freshness status
oncecheck rules status

# List rules (filter by platform/severity/tier)
oncecheck rules list --platform ios --severity FAIL --tier starter

# Inspect one rule in detail
oncecheck rules show IOS-PRIV-001

# Run rule + policy health checks (CI-friendly)
oncecheck rules doctor

Authentication

# Sign in (opens browser)
oncecheck login

# Check status
oncecheck status

# Sign out
oncecheck logout

Configuration

# Generate config files in your project
oncecheck init ./my-project

This creates:

  • .oncecheckrc — YAML config for disabled rules, severity overrides, and fail threshold
  • .oncecheckignore — one rule ID per line to suppress

Example .oncecheckrc:

disabled_rules:
  - IOS-SEC-001
  - WEB-OWASP-003

severity_overrides:
  WEB-A11Y-001: INFO

fail_on: FAIL

Shell Completions

# Bash
oncecheck completions bash >> ~/.bashrc

# Zsh
oncecheck completions zsh >> ~/.zshrc

# Fish
oncecheck completions fish > ~/.config/fish/completions/oncecheck.fish

CI/CD Integration

# GitHub Actions example
- name: Compliance scan
  run: |
    pip install oncecheck
    oncecheck login
    oncecheck scan . --fail-on WARN

- name: Upload SARIF (Team plan)
  run: oncecheck scan . --format sarif --output results.sarif

Exit Codes

Code Meaning
0 No issues (or only INFO)
1 Warnings found
2 Failures found

Plans

Feature Starter (Free) Team ($19/mo or $190/yr)
Compliance rules 35 All 73+
Scans per day 3 Unlimited
Terminal output Yes Yes
JSON/text export Yes
SARIF export Yes
File export (--output) Yes
Priority support Yes

Testing

python -m pytest tests/ -v

License

MIT

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

oncecheck-0.6.1.tar.gz (70.1 kB view details)

Uploaded Source

Built Distribution

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

oncecheck-0.6.1-py3-none-any.whl (72.5 kB view details)

Uploaded Python 3

File details

Details for the file oncecheck-0.6.1.tar.gz.

File metadata

  • Download URL: oncecheck-0.6.1.tar.gz
  • Upload date:
  • Size: 70.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for oncecheck-0.6.1.tar.gz
Algorithm Hash digest
SHA256 cd5fa08074b08bd354ea18f2f255f27b24c8fe0af3b7351bb46ca29be91e9b5b
MD5 49179eeb50adc36801859d9bb6a10403
BLAKE2b-256 bb535e5f1969e9d59e6e59dc2285b97dc69886467478c7c0c0001b864dd5d98f

See more details on using hashes here.

File details

Details for the file oncecheck-0.6.1-py3-none-any.whl.

File metadata

  • Download URL: oncecheck-0.6.1-py3-none-any.whl
  • Upload date:
  • Size: 72.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for oncecheck-0.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 acda7401c0d3341bfa6da5eb9c7299d7de9b26447c35df562b912af3dab67c8a
MD5 7001f4816543e5a7a65d7c9a48dd08b8
BLAKE2b-256 9a309a34144c909ff0d8913ca234562075cb3502a7cc2a6629b4990378932ff3

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