agentic-mobile-kit 0.5.1 → 0.5.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +76 -23
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,51 +1,104 @@
|
|
|
1
1
|
# agentic-mobile-kit
|
|
2
2
|
|
|
3
|
-
One setup for AI-assisted
|
|
3
|
+
One setup for AI-assisted development of bare React Native apps. Every AI tool on the team reads the same rules, project knowledge and workflows. Git hooks and CI check the work, whichever person or tool wrote it. A task started in one tool, or on one machine, carries on in another.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Tested with Claude Code, Codex and Antigravity. `--tools` also sets up Cursor, OpenCode and Kiro.
|
|
6
6
|
|
|
7
|
-
## Install
|
|
7
|
+
## Install
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
In the root of a bare React Native app (one with `ios/` and `android/` folders), on a clean git working tree:
|
|
10
10
|
|
|
11
11
|
```sh
|
|
12
12
|
npx agentic-mobile-kit init
|
|
13
|
-
npx agentic-mobile-kit init --tools claude,codex,antigravity # choose your AI tools
|
|
14
|
-
npx agentic-mobile-kit init --ci github,codemagic # only if the app uses that CI
|
|
15
13
|
```
|
|
16
14
|
|
|
17
|
-
|
|
15
|
+
| Option | What it does |
|
|
16
|
+
|---|---|
|
|
17
|
+
| `--tools claude,codex,antigravity` | The AI tools your team uses (this is the default) |
|
|
18
|
+
| `--ci github,codemagic` | Adds GitHub Actions checks, Codemagic signed builds, or both. Leave it out if the app has no CI. |
|
|
19
|
+
| `--pm yarn` | The package manager, if the lockfile doesn't show it |
|
|
20
|
+
|
|
21
|
+
`init` never overwrites a file. Besides adding the kit's files, it:
|
|
22
|
+
- adds its section to an existing `AGENTS.md` between `KIT` markers, and an `@AGENTS.md` line to an existing `CLAUDE.md`;
|
|
23
|
+
- records the kit version and CI choice in that section, so `sync` knows what's installed;
|
|
24
|
+
- adds `.env`, `.env.*` and `.ai/` to `.gitignore`;
|
|
25
|
+
- adds a `typecheck` script for TypeScript apps;
|
|
26
|
+
- adds a `postinstall` script that turns on the git hooks for every clone;
|
|
27
|
+
- turns on the git hooks for this clone too;
|
|
28
|
+
- generates each chosen tool's permissions, hooks and reviewer agent, and links the skills folder for Claude Code and Kiro.
|
|
29
|
+
|
|
30
|
+
It's safe to run again. Undo it with git.
|
|
31
|
+
|
|
32
|
+
Then check the project and your machine:
|
|
18
33
|
|
|
19
34
|
```sh
|
|
20
35
|
npx agentic-mobile-kit doctor
|
|
21
36
|
```
|
|
22
37
|
|
|
23
|
-
`
|
|
38
|
+
`doctor` gives a fix for each problem it finds, in three groups:
|
|
39
|
+
- **The project:** the kit is installed, `AGENTS.md` is within its size limit, the git hooks are active, no `.env` file is in git, the tool configs are current, and `docs/ai/` is filled in.
|
|
40
|
+
- **This Mac:** Node, installed dependencies, Xcode, CocoaPods and pods, an iPhone simulator, the Android SDK and an emulator, Java, Maestro (the same version as CI) and gitleaks.
|
|
41
|
+
- **The AI tools:** whether Codex and Antigravity trust the project, the Antigravity version, and an `ANTHROPIC_API_KEY` in the shell that would override a Claude subscription.
|
|
42
|
+
|
|
43
|
+
## How work flows
|
|
44
|
+
|
|
45
|
+
| You want to | Run | What happens |
|
|
46
|
+
|---|---|---|
|
|
47
|
+
| Think a problem through | `m-explore` | The agent reads the code, explains how it works today and lays out options with trade-offs. It never edits code. |
|
|
48
|
+
| Build a feature | `m-feature` | Requirements → you approve → design and tasks → you approve → one task at a time with tests → device checks with screenshots → living spec updated → review → PR |
|
|
49
|
+
| Fix a bug | `m-bugfix` | Reproduces the bug, proves it with a failing test, finds the root cause, then makes the smallest fix |
|
|
50
|
+
| Stop, or switch tool or machine | `m-pause` | Writes a handoff in the spec, commits and pushes |
|
|
51
|
+
| Carry on anywhere | `m-continue` | Reads the spec and handoff, then picks up at the next step |
|
|
52
|
+
| Review a branch | `m-review` | Checks the work against the spec (complete, correct, coherent) and covers both platforms, error states, security and native changes |
|
|
53
|
+
| Ship a release | `m-release` | Changelog from real commits, store and client notes, versions, release check, release PR, tag, signed builds |
|
|
54
|
+
| Stop a mistake repeating | `m-learn` | Turns a correction into a lasting check, a known-issues entry or a rule |
|
|
55
|
+
|
|
56
|
+
Invoke a skill with `/m-feature` in Claude Code and Antigravity, or `$m-feature` in Codex. The skills are set to run only when you invoke them.
|
|
57
|
+
|
|
58
|
+
## What it adds to the app
|
|
24
59
|
|
|
25
|
-
|
|
60
|
+
| Area | What you get |
|
|
61
|
+
|---|---|
|
|
62
|
+
| Project knowledge | `AGENTS.md` (with a one-line `CLAUDE.md`): commands, the definition of done and the rules. `docs/ai/`: product, tech stack, structure, conventions, decisions, known issues, React Native rules and team process. Callstack's React Native skills. |
|
|
63
|
+
| Specs | `specs/<id>/` for each feature: requirements, design, tasks, a Maestro flow and a handoff file. A living spec of what the app does now, in `specs/current/`. `spec.js`: `check`, `merge`, `status`. |
|
|
64
|
+
| Device checks | `verify.sh`: lint and tests, release builds on an iPhone simulator and an Android emulator, the feature's Maestro flow, and screenshots in `.ai/evidence/<id>/` |
|
|
65
|
+
| Releases | `release-check.js` catches what store review would reject. Changelog and store notes come from commits (git-cliff). `set-version.sh` sets versions. Signed builds come from `release-build.sh` or Codemagic (`--ci codemagic`). |
|
|
66
|
+
| Guardrails in AI tools | Hooks that block destructive commands and secret files and remind the agent about the handoff, permission rules, and a read-only reviewer, generated with rulesync |
|
|
67
|
+
| Git hooks | Before a commit: secrets, signing files, Xcode project files, ESLint, spec format. Before a push: typecheck and tests. |
|
|
68
|
+
| CI (`--ci github`) | Lint, typecheck, tests, a secret scan, a tool-config check, a 600-line PR limit (`large-pr` label), Android and iOS builds, nightly end-to-end tests (`e2e` label), and a PR template |
|
|
69
|
+
| Everyday scripts | `install-deps.sh`, `pm-run.sh`, `ios-build.sh` |
|
|
70
|
+
|
|
71
|
+
All scripts are in `scripts/ai/`. The [team guide](docs/team-guide.md) has the details.
|
|
72
|
+
|
|
73
|
+
## Alongside other AI workflows
|
|
74
|
+
|
|
75
|
+
Apps that already use Superpowers, BMAD, proAgents or similar keep them as they are. The kit adds its section next to theirs and links its skills into an existing `.claude/skills` folder. A task started with an `m-` skill follows the kit's steps, and everything else keeps working as before.
|
|
76
|
+
|
|
77
|
+
## Update or remove
|
|
26
78
|
|
|
27
79
|
```sh
|
|
28
|
-
npx agentic-mobile-kit@latest sync # update the kit's files
|
|
80
|
+
npx agentic-mobile-kit@latest sync # update the kit's files, merging in your own changes
|
|
29
81
|
npx agentic-mobile-kit uninstall # remove the kit; files you changed are kept and listed
|
|
30
82
|
```
|
|
31
83
|
|
|
32
|
-
Both need a clean working tree
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
84
|
+
Both need a clean working tree and leave the result for you to review with `git diff`.
|
|
85
|
+
- **Report:** `sync` lists what it updated, added, removed and merged.
|
|
86
|
+
- **Conflicts:** if you and the kit changed the same lines, the file gets `<<<<<<<` conflict markers to resolve.
|
|
87
|
+
- **Your docs:** the product, tech, structure and conventions files your team filled in are never changed.
|
|
88
|
+
- **Adding CI later:** `sync --ci github` or `--ci codemagic` does it.
|
|
89
|
+
- **Older installs:** installs from before 0.4.0 pass the kit version they started from, for example `--from 0.3.0`.
|
|
90
|
+
- **What `uninstall` leaves:** the `.gitignore` lines and the `typecheck` script.
|
|
37
91
|
|
|
38
|
-
##
|
|
92
|
+
## Requirements
|
|
39
93
|
|
|
40
|
-
-
|
|
41
|
-
- **Workflows:** the skills `m-explore`, `m-feature`, `m-bugfix`, `m-continue`, `m-pause`, `m-review`, `m-release` and `m-learn`. Invoke them with `/m-feature` in Claude Code and Antigravity, or `$m-feature` in Codex. Also Callstack's React Native skills.
|
|
42
|
-
- **Guardrails in each tool:** a guard hook that blocks destructive commands and secret files, a stop hook that asks for a handoff update, permission rules and a read-only `m-reviewer` subagent, generated with rulesync.
|
|
43
|
-
- **Releases:** `m-release` writes each release's changelog from real commits with git-cliff, plus store and client notes, all in `release-notes/<version>/`. It then runs `scripts/ai/release-check.js`, which catches what store review would reject. Signed builds come from `scripts/ai/release-build.sh` on a Mac: an app bundle signed with your upload key, and an `.ipa` signed through Xcode's account. With `--ci codemagic`, a version tag starts them on Codemagic instead (`codemagic.yaml`, one-time setup in `docs/ai/codemagic.md`).
|
|
44
|
-
- **Checks no tool can skip:** git hooks (secrets, signing files, broken Xcode project files, lint, typecheck, tests) and, with `--ci github`, GitHub Actions CI (lint, typecheck, tests, secret scan, PR size, Android and iOS builds, nightly Android end-to-end tests).
|
|
94
|
+
- macOS, git and Node.js 20 or later. `doctor` checks everything else.
|
|
45
95
|
|
|
46
|
-
|
|
96
|
+
## More
|
|
47
97
|
|
|
48
|
-
|
|
98
|
+
- [Team guide](docs/team-guide.md): day-to-day use, what's enforced, troubleshooting and a 1-hour training plan.
|
|
99
|
+
- [Branch protection](docs/branch-protection.md): the GitHub settings that make the CI checks required.
|
|
100
|
+
- [Tool matrix](docs/tool-matrix.md): how the kit was tested in each AI tool and on a real app.
|
|
101
|
+
- Published from GitHub Actions with npm provenance.
|
|
49
102
|
|
|
50
103
|
## License
|
|
51
104
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "agentic-mobile-kit",
|
|
3
|
-
"version": "0.5.
|
|
3
|
+
"version": "0.5.2",
|
|
4
4
|
"description": "One setup for AI-assisted mobile development that works the same in Claude Code, Codex, Cursor, OpenCode, Kiro and Antigravity. Early development.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": "prakashpro1",
|