Content
# Everything Maa
Everything Maa is a focused toolkit of reusable AI skills for MaaFramework projects. Its canonical content covers project creation and discovery, Pipeline authoring and generation, option wiring, graph analysis, testing, history auditing, and guarded CLI operation.
> Status: pre-release development baseline. The canonical skills, native plugin manifests, MCP profiles, and installer are implemented and tested locally; the npm package and GitHub repository have not been published yet.
## Install
After the first npm release, install into a project with one of these commands:
```bash
npx everything-maa@latest install --target claude
npx everything-maa@latest install --target codex
```
For a local checkout, replace `npx everything-maa@latest` with `node packages/cli/bin/everything-maa.js`.
After the GitHub repository is public, Claude Code can also install the native plugin through its self-hosted marketplace:
```text
/plugin marketplace add https://github.com/KhazixW2/Everything-Maa
/plugin install everything-maa@everything-maa
```
The default `core` profile installs all nine skills and configures MaaMCP. Profiles are explicit and versioned:
| Profile | Installed components |
| --- | --- |
| `skills-only` | Maa skills only |
| `core` | Maa skills + MaaMCP |
| `authoring` | Core + create-maa-project project lifecycle MCP |
| `full` | Authoring + isolated Playwright MCP |
Useful operations:
```bash
npx everything-maa list
npx everything-maa doctor
npx everything-maa install --target codex --profile authoring
npx everything-maa install --target codex --profile full --dry-run
npx everything-maa uninstall --target codex
```
Project scope is the default. User-scope skill installation is available through `--scope user`; Claude user-scope MCP merging is intentionally excluded because it would require editing Claude's shared global configuration. Use `--profile skills-only`, project scope, or the native plugin in that case.
The installer records exactly what it owns. Uninstall removes an installed skill only when its content still matches the recorded hash, preserves unrelated MCP entries, and leaves locally modified content in place with recovery state.
## Core skills
| Skill | Purpose |
| --- | --- |
| `maa-cli-operate` | Run repeatable device, recognition, action, and Pipeline operations through maafw-cli. |
| `maa-project-create` | Create, extend, diagnose, and update Maa projects through create-maa-project. |
| `maa-project-init` | Scan a Maa project and produce a reusable `basic_info.md` handoff. |
| `maa-pipeline-guide` | Design and review MaaFramework Pipeline JSON. |
| `maa-pipeline-generate` | Generate recognition/action nodes and sweep OCR ROIs. |
| `maa-pipeline-option` | Wire runtime options across UI, Pipeline, and Python. |
| `maa-pipeline-testing` | Validate resources, recognition, Custom wiring, and runtime flows. |
| `maa-pipeline-graph` | Map Pipeline state relationships and external Python entries. |
| `maa-pipeline-history-audit` | Learn Pipeline and Custom conventions from Git history. |
Project-specific workflows belong under `recipes/` and are not installed as core skills.
## Repository layout
- `skills/`: canonical Maa skills; each directory is independently installable.
- `recipes/`: optional project or task recipes.
- `evals/`: skill evaluation cases kept outside installed skill payloads.
- `adapters/`: distribution metadata for MaaHub and future agent harnesses.
- `distribution/`: versioned status and paths for every supported release channel.
- `integrations/`: runtime routing metadata for MCP and optional CLI tools.
- `mcp/`: versioned MCP server catalog and profiles.
- `.claude-plugin/` and `.codex-plugin/`: native plugin manifests.
- `packages/cli/`: dependency-free Node.js installer.
- `tests/`: portable fixtures and repository invariants.
- `.github/workflows/`: cross-platform CI and tag-gated trusted publishing.
The completed six-phase roadmap and remaining public-release gate are documented in [docs/roadmap.md](docs/roadmap.md).
## Development
```bash
python -m pip install -r requirements-dev.txt
python -m pytest
python scripts/validate_skills.py
npm test
npm run release:check
npm pack --dry-run
```
When changing the create-maa-project integration, also run the networked upstream smoke test:
```bash
npm run smoke:create-project
```
When changing the maafw-cli integration, run its non-device upstream contract smoke test:
```bash
npm run smoke:maafw-cli
```
The current baseline supports Python 3.10 and later and Node.js 18 and later. Do not assume a skill is installed under `.claude/skills`, a particular drive letter, or the Everything Maa checkout itself.
## Scope and dependencies
Everything Maa does not vendor create-maa-project, MaaMCP, maafw-cli, Playwright MCP, MaaFramework binaries, or OCR models. MCP and CLI launch contracts reference upstream packages and pin versions per Everything Maa release. MaaMCP, create-maa-project, and the experimental maafw-cli skill require `uvx`; Playwright MCP requires `npx`. maafw-cli runs on demand and is not installed persistently by a profile.
See [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md) for license boundaries and [README.zh-CN.md](README.zh-CN.md) for Chinese documentation.
## License
Everything Maa's own skills, scripts, tests, and documentation are released under the [MIT License](LICENSE). Third-party runtimes keep their upstream licenses.
Everything Maa is a community project and is not an official MaaFramework distribution unless explicitly stated otherwise.