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

# Advanced engine profile and strict compiler-grade requirement
oncecheck scan ./my-project --analysis-mode hybrid --advanced-profile codeql-first --require-compiler-engine

# Filter low-confidence findings
oncecheck scan ./my-project --min-confidence 0.80

# 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

# Show rule impact from recent policy source updates
oncecheck rules impact --within-days 7

# 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

Benchmark Quality Gates

# Score predictions vs truth labels
oncecheck benchmark score --predictions results.json --truth truth.json

# Enforce minimum quality thresholds for CI (exit 2 on failure)
oncecheck benchmark gate --predictions results.json --truth truth.json \
  --min-precision 0.80 --min-recall 0.80 --min-f1 0.80 --min-tp 1

# Run calibrated multi-suite gates (OWASP/Juliet slices)
oncecheck benchmark gate-config --config benchmarks/ci/gate_config.json

# Generate a starter truth template
oncecheck benchmark template --suite owasp-benchmark --output truth-template.json

Advanced Engines

# Show CodeQL/Semgrep availability and detected project languages
oncecheck engines .

Suppressions with Justification

# Add suppression with required reason
oncecheck suppress add WEB-OWASP-003 --path . --reason "Legacy markdown renderer pending replacement"

# List suppressions and recorded reasons
oncecheck suppress list --path .

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.7.3.tar.gz (102.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.7.3-py3-none-any.whl (102.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: oncecheck-0.7.3.tar.gz
  • Upload date:
  • Size: 102.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.7.3.tar.gz
Algorithm Hash digest
SHA256 412fc4270bf79c226926e3dbc05afd10960a632d3ba3d8477a0aaa3ff4a57060
MD5 cea19706a8c8306d41b7127a6c129713
BLAKE2b-256 5b1ea0cb7b4d1a0409c34174a2d7de213264846157be7dcb3d3a29732dc1b8d2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: oncecheck-0.7.3-py3-none-any.whl
  • Upload date:
  • Size: 102.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.7.3-py3-none-any.whl
Algorithm Hash digest
SHA256 2de891047507f6b0fdf10434622c0bf34928df160435ded17007f1b993c44d14
MD5 b4a9125b459a33ad9d3afdd12c557d75
BLAKE2b-256 2302032c408778b58b3d6c4f1fe5f17586de4d777a85859e8e47053c4ca32590

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