Skip to content
Back to search

shelfready

MarketplaceWorks with Claude CodeGitHub

ShelfReady for Claude Code: get an iOS app ready for the App Store.

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/halfbatch-studio--shelfready/badge.svg)](/listings/halfbatch-studio--shelfready)

HTML

<a href="/listings/halfbatch-studio--shelfready"><img src="/api/listings/halfbatch-studio--shelfready/badge.svg" alt="findsafeskills safety rating" /></a>

Install

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

brew install halfbatch-studio/tap/shelfready   # or: npm install -g shelfready   (Node 20+)

cd ~/path/to/your-app
shelf init --country DE --email support@example.com --brand "Your Studio" --voice I --base-url https://example.com/app/
# review shelfready.yaml: add privacy notes and FAQ
shelf pages --swiftui MyApp/LegalView.swift   # privacy, support, Impressum + in-app view
shelf store                                   # fastlane/app_privacy_details.json
shelf check --ci                              # fails on drift
shelf checklist --online                      # what's left before you submit

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

.claude-plugin/marketplace.json · Manifest · 12 lines
  1. {
  2. "name": "shelfready",
  3. "owner": { "name": "Half Batch", "email": "hello@shelfready.dev", "url": "https://shelfready.dev" },
  4. "description": "ShelfReady for Claude Code: get an iOS app ready for the App Store.",
  5. "plugins": [
  6. {
  7. "name": "shelfready",
  8. "source": "./plugin",
  9. "description": "Legal pages, App Privacy answers and a go-live checklist for iOS apps, from the app's own code. Skill plus MCP server."
  10. }
  11. ]
  12. }
README.md · README · 120 lines
  1. # ShelfReady
  2. Get an iOS app ready for the App Store shelf. ShelfReady reads your repo and keeps the non-code parts of a release honest: the privacy policy, support page and Impressum, your App Privacy answers, and a go-live checklist. In CI it fails the build when a new SDK or data type isn't covered by your policy.
  3. It does not upload builds or fill in App Store Connect; use [`asc`](https://github.com/rudrankriyam/App-Store-Connect-CLI) or fastlane for that. ShelfReady covers the legal, privacy and web layer around them, with the EU steps most tools skip.
  4. Try it in your app's repo, nothing to install:
  5. ```sh
  6. npx -y shelfready check
  7. ```
  8. Website, the full checklist and what common SDKs collect: **[shelfready.dev](https://shelfready.dev)**
  9. ## Quick start
  10. ```sh
  11. brew install halfbatch-studio/tap/shelfready # or: npm install -g shelfready (Node 20+)
  12. cd ~/path/to/your-app
  13. shelf init --country DE --email support@example.com --brand "Your Studio" --voice I --base-url https://example.com/app/
  14. # review shelfready.yaml: add privacy notes and FAQ
  15. shelf pages --swiftui MyApp/LegalView.swift # privacy, support, Impressum + in-app view
  16. shelf store # fastlane/app_privacy_details.json
  17. shelf check --ci # fails on drift
  18. shelf checklist --online # what's left before you submit
  19. ```
  20. ## Commands
  21. | Command | What it does |
  22. |---|---|
  23. | `shelf scan` | Reads bundle IDs, display names, permission texts (Info.plist and `INFOPLIST_KEY_*`), privacy manifests (XML or binary), export compliance, and packages from Package.resolved, Podfile.lock and Cartfile.resolved |
  24. | `shelf init` | Writes `shelfready.yaml` from the scan plus your publisher details; known SDKs add what they collect |
  25. | `shelf pages` | Privacy policy, support page and Impressum (Germany and Austria) as Markdown with Jekyll front matter; `--swiftui` writes a `LegalView` for the in-app Impressum |
  26. | `shelf store` | App Privacy answers in fastlane's `app_privacy_details.json` format; data types without an App Store Connect category are reported, never guessed |
  27. | `shelf check` | Drift between `shelfready.yaml` and the repo, missing manifests, placeholder permission texts, unknown SDKs, trader details, in-app Impressum. `--ci` exits 1 on errors, `--online` checks the published pages, `--format github` annotates pull requests |
  28. | `shelf checklist` | The go-live checklist: automatic items from `check`, manual ones you tick with `--done <id>`; `--markdown` writes it as a file |
  29. | `shelf migrate` | Updates `shelfready.yaml` to the current schema, keeping your comments and style |
  30. | `shelf agents` | Adds a short note to `AGENTS.md` (or `CLAUDE.md`) so coding agents in the repo run the checks before a release; `shelf init` offers it |
  31. | `shelf mcp` | Runs the MCP server on stdio, so Claude and other agents can use all of the above |
  32. ## Use with your coding agent
  33. ShelfReady includes an MCP server (`shelf mcp`) and a skill, so the agent you build your app with can run the whole go-live flow: scan the repo, ask you for the publisher details it can't know, write the pages and App Privacy answers, and work through the checklist.
  34. **Claude Code** (terminal, VS Code, JetBrains, desktop): install the plugin, which adds the skill and starts the server.
  35. ```sh
  36. claude plugin marketplace add halfbatch-studio/shelfready
  37. claude plugin install shelfready@shelfready
  38. ```
  39. Then ask: "get this app ready for the App Store".
  40. **Codex CLI:**
  41. ```sh
  42. codex mcp add shelfready -- npx -y shelfready mcp
  43. ```
  44. **Cursor, Claude Desktop, Windsurf and other MCP clients:** add this to the client's MCP config (for Cursor, `.cursor/mcp.json` in your app repo).
  45. ```json
  46. {
  47. "mcpServers": {
  48. "shelfready": { "command": "npx", "args": ["-y", "shelfready", "mcp"] }
  49. }
  50. }
  51. ```
  52. Tools: `scan`, `init`, `check`, `checklist`, `tick`, `pages`, `app_privacy`, `sdk_info`, `migrate`. Each takes `path`, the app repo, and only ever writes inside it. The server is listed in the [MCP Registry](https://registry.modelcontextprotocol.io) as `io.github.halfbatch-studio/shelfready`.
  53. The skill, [`plugin/skills/shelfready/SKILL.md`](plugin/skills/shelfready/SKILL.md), follows the open Agent Skills format: copy the folder into any agent that reads skills, or upload it to claude.ai.
  54. ## GitHub Action
  55. ```yaml
  56. # .github/workflows/shelfready.yml
  57. name: ShelfReady
  58. on: [push, pull_request]
  59. jobs:
  60. check:
  61. runs-on: ubuntu-latest
  62. steps:
  63. - uses: actions/checkout@v4
  64. - uses: halfbatch-studio/shelfready@v0
  65. with:
  66. online: "false" # "true" also checks the live pages
  67. ```
  68. Inputs: `path` (folder with `shelfready.yaml`, default `.`), `online` (default `false`), `fail-on-error` (default `true`). Findings appear as annotations and in the job summary.
  69. ## What ShelfReady knows about SDKs
  70. `cli/knowledge/` describes 21 common SDKs (Firebase, RevenueCat, Sentry, Mixpanel, Amplitude, PostHog, Facebook, OneSignal, Bugsnag, Datadog, Segment, TelemetryDeck, Adapty, Superwall, Google Sign-In, Supabase, Alamofire, Kingfisher, SDWebImage, Lottie, Realm). Every entry is generated from the SDK's own privacy manifest and records the commit it came from; `npm run kb:import` refreshes them. Additions are welcome: add the SDK to `cli/knowledge/sources.yaml` and run the import.
  71. ## Config: `shelfready.yaml`
  72. One file in your app repo holds the facts behind your pages: app, publisher (`voice: I` or `we`, trader status, Impressum details), collected data, privacy notes, FAQ, page URLs and checklist ticks. It's versioned: when ShelfReady changes the format, `shelf migrate` updates the file and lists what to review. See [`examples/kipple`](examples/kipple) for a real one and its generated output.
  73. ## Status and limits
  74. - Version 0.2. Used to ship [kipple](https://halfbatch.studio/kipple/); expect rough edges.
  75. - **Not legal advice.** Page templates are drafts based on § 5 DDG, the GDPR and Apple's rules, not yet reviewed by a lawyer. You're responsible for what your pages say.
  76. - iOS only for now.
  77. ## Repository
  78. ```
  79. cli/ the `shelf` CLI and its core library (TypeScript), tests, SDK knowledge base
  80. site/ shelfready.dev, generated from the same checklist items as the CLI
  81. examples/ real configs and output
  82. action.yml the GitHub Action
  83. plugin/ the Claude Code plugin: skill and MCP server config
  84. ```
  85. ## License
  86. [Apache-2.0](LICENSE) © Half Batch. The license covers the code, not the names: "ShelfReady" and "Half Batch" aren't licensed for use by forks (see [NOTICE](NOTICE)).

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.