Repository navigation
Installation
This guide is for first-time users who want Mobile AI Agents installed in their AI coding tool without needing to understand the repo structure first.
If you are starting from only an app idea, create the starter project docs first:
npx mobile-ai-agents startIt asks for your idea, platform, team, design status, monetization plan, and stack. Then it creates:
PRD.mdDESIGN.mdTASKS.mdROADMAP.mdMOBILE_MEMORY.md
If you already have a project and just want the AI tools installed, use the default install:
npx mobile-ai-agents installThis installs Mobile AI Agents for Claude Code. It adds agents, skills, and workflows as slash commands in:
~/.claude/commands/
~/.claude/agents/
After install, open Claude Code in your app project and try:
/mobile-harness
/flutter-review
/android-tdd
/crasher
You need:
- Node.js 18 or newer
- An AI coding tool such as Claude Code, Cursor, Windsurf, GitHub Copilot, or Codex
- A terminal opened in the project where you want the rules installed
Check Node.js:
node --versionIf this prints a version like v18.x, v20.x, or newer, you are ready.
If you plan to use /mobile-mcp-qa with Android, also install Android Studio, Platform-Tools, and an emulator image or connect an authorized device. Verify the setup with:
npx mobile-ai-agents doctor --platform androidThen follow the Android Device QA Setup guide to configure Mobile MCP and the project test flow.
Choose the tool you use most often:
| I use... | Run this |
|---|---|
| Claude Code | npx mobile-ai-agents install |
| Cursor | npx mobile-ai-agents install --tool cursor |
| Windsurf | npx mobile-ai-agents install --tool windsurf |
| GitHub Copilot | npx mobile-ai-agents install --tool copilot |
| Codex / OpenAI | npx mobile-ai-agents install --tool codex |
| More than one tool | npx mobile-ai-agents install --tool all |
If you do not know which one to pick, start with the command for your editor. For example, Cursor users should use --tool cursor.
Open a terminal inside your mobile app project, not inside Mobile AI Agents.
Example:
cd ~/Code/my-flutter-app
npx mobile-ai-agents install --tool cursorWhy this matters:
- Cursor installs files into your current project under
.cursor/rules/ - Windsurf installs
.windsurfrulesinto your current project - Copilot installs
.github/copilot-instructions.mdinto your current project - Codex installs
AGENTS.mdinto your current project - Claude Code installs globally into
~/.claude/
By default, Mobile AI Agents installs all platforms:
- Android
- iOS
- Flutter
- React Native
- Unity / Unreal
- Cross-platform workflows
For a smaller install, choose one platform:
npx mobile-ai-agents install --platform android
npx mobile-ai-agents install --platform ios
npx mobile-ai-agents install --platform flutter
npx mobile-ai-agents install --platform rn
npx mobile-ai-agents install --platform gamingYou can combine platform and tool:
npx mobile-ai-agents install --platform flutter --tool cursor
npx mobile-ai-agents install --platform android --tool codex
npx mobile-ai-agents install --platform rn --tool all| Tool | Files created |
|---|---|
| Claude Code |
~/.claude/agents/*.md and ~/.claude/commands/*.md
|
| Cursor | .cursor/rules/*.mdc |
| Windsurf | .windsurfrules |
| GitHub Copilot | .github/copilot-instructions.md |
| Codex / OpenAI | AGENTS.md |
The install command does not change your application source code. It only adds instruction files for your AI coding tool.
npx mobile-ai-agents installThen open Claude Code and run a slash command:
/crasher
Paste a crash log and ask for the root cause.
npx mobile-ai-agents install --tool cursorThen use Cursor Chat:
@axiom review this ViewModel
@flutter-review review this widget
npx mobile-ai-agents install --tool windsurfWindsurf reads .windsurfrules from your project. After install, ask Windsurf to use the relevant Mobile AI Agents agent or skill.
npx mobile-ai-agents install --tool copilotThen use Copilot Chat with workspace context:
@workspace Review this file using the Android code reviewer rules.
npx mobile-ai-agents install --tool codexThis creates AGENTS.md in your project. Codex reads that file as project instructions when working in the repo.
Use this if you cloned the Mobile AI Agents repo and want to install from local files instead of npm:
git clone https://github.com/salmanashraf/mobile-agency
cd mobile-agency
./install.sh --platform android
./install.sh --platform flutter --tool cursor
./install.sh --tool allFor most users, npx mobile-ai-agents install is simpler.
Install Node.js from nodejs.org and reopen your terminal.
Use the full npx command:
npx mobile-ai-agents installMake sure the command created files under:
.cursor/rules/
Then restart Cursor or reload the window.
Make sure AGENTS.md exists at the root of the project you opened in Codex.
Run the install command again with the platform you want:
npx mobile-ai-agents install --platform flutter --tool cursor| Project type | Try first |
|---|---|
| Android |
/axiom or /compose-review
|
| iOS | /swift-review |
| Flutter | /flutter-review |
| React Native |
/rn-review or /perf-audit
|
| Unity / Unreal |
/game-perf or /blueprint-to-cpp
|
| Any app |
/crasher, /release-prep, /store-listing
|
If you maintain the GitHub Wiki, copy this page into a wiki page named:
Installation
Suggested wiki URL:
https://github.com/salmanashraf/mobile-agency/wiki/Installation
Getting Started
Documentation
- All Documentation
- Installation
- Figma MCP and Design Handoff
- Figma Spec Tools
- Core Loops
- Mobile Engineering Loop
- Mobile Memory
- Performance Loop
Reference
- Agents
- Platform Guide
- Skills and Prompts
- Android Device QA Setup
- Mobile App Design Skill
- Mobile Harness
- Enterprise Mobile Harness
- Workflows
- Reference
Community
Repository github.com/salmanashraf/mobile-ai-agents
Version: v1.0.38 · MIT License