{"id":47691803,"url":"https://github.com/yunusemreyakisan/preflight","last_synced_at":"2026-04-02T15:43:33.712Z","repository":{"id":346386541,"uuid":"1189004190","full_name":"yunusemreyakisan/preflight","owner":"yunusemreyakisan","description":"CLI for App Store review checks on iOS, Flutter, and React Native apps.","archived":false,"fork":false,"pushed_at":"2026-03-24T13:32:03.000Z","size":227,"stargazers_count":10,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"stable","last_synced_at":"2026-03-24T13:40:49.228Z","etag":null,"topics":["app-review","app-store","app-store-submission","ci","cli","fastlane","flutter","ios","nodejs","preflight","privacy-manifest","react-native","release-engineering","review-readiness","reviewer-pack","storekit","typescript","xcode"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yunusemreyakisan.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-03-22T21:37:48.000Z","updated_at":"2026-03-24T13:32:21.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/yunusemreyakisan/preflight","commit_stats":null,"previous_names":["yunusemreyakisan/preflight"],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/yunusemreyakisan/preflight","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yunusemreyakisan%2Fpreflight","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yunusemreyakisan%2Fpreflight/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yunusemreyakisan%2Fpreflight/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yunusemreyakisan%2Fpreflight/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yunusemreyakisan","download_url":"https://codeload.github.com/yunusemreyakisan/preflight/tar.gz/refs/heads/stable","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yunusemreyakisan%2Fpreflight/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31309235,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-02T12:59:32.332Z","status":"ssl_error","status_checked_at":"2026-04-02T12:54:48.875Z","response_time":89,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["app-review","app-store","app-store-submission","ci","cli","fastlane","flutter","ios","nodejs","preflight","privacy-manifest","react-native","release-engineering","review-readiness","reviewer-pack","storekit","typescript","xcode"],"created_at":"2026-04-02T15:43:31.012Z","updated_at":"2026-04-02T15:43:33.704Z","avatar_url":"https://github.com/yunusemreyakisan.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Preflight\n\n[![Hypercommit](https://img.shields.io/badge/Hypercommit-DB2475)](https://hypercommit.com/preflight)\n[![CI](https://github.com/yunusemreyakisan/preflight/actions/workflows/ci.yml/badge.svg)](https://github.com/yunusemreyakisan/preflight/actions/workflows/ci.yml)\n[![Release](https://img.shields.io/github/v/release/yunusemreyakisan/preflight?display_name=tag)](https://github.com/yunusemreyakisan/preflight/releases)\n\nPreflight is a CLI for detecting App Store submission risk from local iOS project files before a build reaches App Review.\n\nIt is built for mobile teams that want deterministic, evidence-backed checks in local workflows and CI. Preflight auto-discovers Apple-side project facts, optionally reads live App Store Connect release data, merges a sparse override config, and reports what was detected, what still needs human input, and what changed since the previous scan.\n\n\u003cimg width=\"1280\" alt=\"Preflight scan dashboard with baseline diff and GitHub Actions annotations\" src=\"assets/preflight-hero.svg\" /\u003e\n\n```bash\nnpx @yakisan/preflight scan\n```\n\n## Overview\n\n- Detect App Store submission risk before uploading a build for review\n- Catch missing review-readiness inputs such as demo accounts, login instructions, and review notes\n- Inspect privacy, metadata, StoreKit, screenshot, and capability signals from local Apple project files\n- Compare local values against App Store Connect metadata, review notes, screenshots, territories, and IAP listings\n- Produce human-readable, JSON, baseline-diff, and CI-friendly output\n\n## Quick Start\n\nPreflight requires Node.js 20 or newer and is distributed through npm.\n\nRun a full scan without creating any config first:\n\n```bash\nnpx @yakisan/preflight scan\n```\n\nOr install it globally:\n\n```bash\nnpm install -g @yakisan/preflight\npreflight scan\n```\n\nUseful first commands:\n\n- Full scan: `npx @yakisan/preflight scan`\n- Machine-readable output: `npx @yakisan/preflight scan --json`\n- Compare with a previous report: `npx @yakisan/preflight scan --baseline preflight-report.json`\n- Emit GitHub Actions annotations: `npx @yakisan/preflight scan --annotations github`\n- Skip App Store Connect calls: `npx @yakisan/preflight scan --skip-app-store-connect`\n- CLI version: `npx @yakisan/preflight --version`\n- Generate an override template: `npx @yakisan/preflight init`\n\n## What Preflight Checks\n\nPreflight evaluates 30 deterministic rules across:\n\n- Reviewer access and reviewer documentation\n- App completeness and release readiness\n- Metadata quality and screenshot coverage heuristics\n- Privacy signals including tracking usage description and privacy manifest presence\n- StoreKit and monetization readiness\n- Content and age-rating related declarations\n- Optional App Store Connect drift checks across review notes, metadata, screenshots, territories, and IAPs\n\n## Supported Projects and Discovery Sources\n\nSupported project types:\n\n- Native iOS\n- Flutter iOS through the `ios/` project\n- React Native iOS through the `ios/` project\n\nDiscovery still starts from local Apple-side files, but `preflight scan` can also read remote App Store Connect data.\n\nOn the first interactive local run, if no App Store Connect credentials are configured, `preflight scan` opens the App Store Connect API Keys page and walks through a guided setup. The saved settings live at `~/.config/preflight/app-store-connect.json` and store `issuerId`, `keyId`, an optional `appId`, and the path to the downloaded `.p8` key.\n\nEnvironment variables still work and take precedence over the saved local config.\n\nIn CI or any non-interactive shell, guided setup does not run. Use the saved local config from a prior local run, or provide `ASC_*` environment variables explicitly.\n\nCurrent discovery sources include:\n\n- `Info.plist`\n- `.xcodeproj/project.pbxproj`\n- Entitlements files\n- `PrivacyInfo.xcprivacy`\n- `.storekit`\n- Screenshot folders such as `fastlane/screenshots`\n\nOptional App Store Connect environment variables:\n\n- `ASC_ISSUER_ID`\n- `ASC_KEY_ID`\n- `ASC_PRIVATE_KEY` or `ASC_PRIVATE_KEY_PATH`\n- `ASC_APP_ID` to target a specific app directly instead of resolving by bundle ID\n\n## Commands\n\nCore commands:\n\n| Command | Purpose |\n| --- | --- |\n| `preflight scan` | Run a full submission risk scan |\n| `preflight init` | Create an optional override template |\n| `preflight rules` | List bundled rules and metadata |\n\nKey flags:\n\n- `--lang \u003clocale\u003e`: output locale\n- `-v, --version`: print the current CLI version\n- `--config \u003cpath\u003e`: path to an optional override file\n- `--json`: machine-readable output\n- `--baseline \u003cpath\u003e`: compare the current scan against a previous JSON scan report\n- `--annotations \u003ctarget\u003e`: emit workflow annotations, currently `github`\n- `--skip-app-store-connect`: disable remote App Store Connect checks for this run\n- `--ci`: concise CI output for `scan`\n- `--strict`: treat `MEDIUM` risk as blocking for `scan`\n- `--plain`: disable branded terminal formatting\n- `--update`: include bundled rule metadata for `rules`\n- `--force`: overwrite an existing file for `init`\n\nPreflight automatically falls back to plain terminal output when `stdout` is not a TTY or `NO_COLOR=1` is present.\n\nSupported locales:\n\n- `en`\n- `tr`\n- `de`\n- `fr`\n- `es`\n- `it`\n- `pt-BR`\n- `ja`\n- `ko`\n- `zh-CN`\n\nEnglish and Turkish currently have full localized messaging. Other bundled locales fall back to English for untranslated keys.\n\n## Optional Override Config\n\n`preflight scan` discovers what it can from local project files first, then merges `preflight.config.json` only if the file exists.\n\nUse the override config only for reviewer-only inputs and deliberate overrides that cannot be inferred reliably from local files.\nUse the override config only for review-only inputs and deliberate overrides that cannot be inferred reliably from local files. Empty string placeholders are treated as missing so App Store Connect values can still fill them during `scan`.\n\nMinimal example:\n\n```json\n{\n  \"appCapabilities\": {\n    \"loginRequired\": true\n  },\n  \"review\": {\n    \"demoAccountRequired\": true,\n    \"demoAccount\": {\n      \"username\": \"reviewer@example.com\",\n      \"password\": \"password123\",\n      \"notes\": \"\"\n    },\n    \"contact\": {\n      \"name\": \"Release Team\",\n      \"email\": \"mobile@example.com\",\n      \"phone\": \"\"\n    },\n    \"notes\": \"Use the demo account to sign in, then open Settings -\u003e Upgrade to review the subscription paywall.\",\n    \"loginInstructions\": \"Open the app, tap Sign In, use the demo credentials above, then navigate to Settings -\u003e Upgrade.\",\n    \"internetRequired\": true\n  },\n  \"privacy\": {\n    \"policyUrl\": \"https://example.com/privacy\",\n    \"nutritionLabelComplete\": true\n  }\n}\n```\n\n## Baseline Diffs and PR Annotations\n\nStore a JSON report from one run, then compare future scans against it:\n\n```bash\nnpx @yakisan/preflight scan --json \u003e preflight-report.json\nnpx @yakisan/preflight scan --baseline preflight-report.json\n```\n\nFor GitHub Actions or pull request workflows, emit annotations directly into the job log:\n\n```bash\nnpx @yakisan/preflight scan --annotations github\n```\n\n## CI Example\n\nUse Preflight as a gate in CI:\n\n```yaml\n- name: Preflight Scan\n  run: npx @yakisan/preflight scan --ci --annotations github --json \u003e preflight-report.json\n```\n\nScan output includes `risk_level`, `risk_score`, `blocking_issues`, `warnings`, discovery evidence, `missing_inputs`, `review_readiness`, and `app_store_connect`.\n\n## Exit Codes\n\n- `0`: low risk\n- `1`: medium risk or non-blocking warning\n- `2`: high risk or blocked release\n\nWith `preflight scan --strict`, `MEDIUM` risk also exits with `2`.\n\nLicensed under the [MIT License](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyunusemreyakisan%2Fpreflight","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyunusemreyakisan%2Fpreflight","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyunusemreyakisan%2Fpreflight/lists"}