内容
<p align="center">
<img src="assets/readme-hero.svg" alt="Memi 审核接口，报告基于文件的设计发现，并验证重新运行而无需编写源文件。" width="100%" />
</p>
<p align="center">
<a href="https://www.npmjs.com/package/@memi-design/cli"><img src="https://img.shields.io/npm/v/@memi-design/cli?color=bd3f63&label=npm" alt="npm 版本"></a>
<a href="https://www.npmjs.com/package/@memi-design/cli"><img src="https://img.shields.io/npm/dw/@memi-design/cli?color=171718&label=每周下载量" alt="每周 npm 下载量"></a>
<a href="https://github.com/memi-design/memi/actions/workflows/ci.yml"><img src="https://github.com/memi-design/memi/actions/workflows/ci.yml/badge.svg?branch=main" alt="持续集成"></a>
<a href="https://github.com/memi-design/memi/stargazers"><img src="https://img.shields.io/github/stars/memi-design/memi?style=social" alt="GitHub 星标"></a>
<a href="https://github.com/memi-design/memi/blob/main/LICENSE"><img src="https://img.shields.io/badge/许可证-MIT-171718.svg" alt="MIT 许可证"></a>
</p>
# memi
只读设计工程，适用于编码代理。
Memi 是 **只读设计工程审计和技能层，适用于编码代理**。它为 Codex、Claude Code、Cursor、Grok Build 和 MCP 客户端提供基于文件的接口证据，然后再编辑 UI。
Memi 读取您已有的产品，识别可访问性、层次结构、状态、响应式、运动和令牌风险，然后在修复后重新运行相同的确定性检查。您的代码仍然是真实来源。
**当前支持：** Node 20、22 和 24，适用于 macOS、Linux 和 Windows。Figma 和 [Studio](https://memoire.cv/download) 是可选的配套工具。
**链接：** [npm](https://www.npmjs.com/package/@memi-design/cli) · [memoire.cv](https://memoire.cv) · [当前版本](docs/CURRENT_RELEASE.md) · [MCP 注册表](https://registry.modelcontextprotocol.io) · [代理技能](https://skills.sh/memi-design/memi)
## 快速入门
在任何前端存储库中运行一次审计：
```bash
npx -y @memi-design/cli@2.6.4 diagnose . --json --no-write --fail-on none
```
您将获得分数、规范的发现 ID、置信度、来源和 `file:line` 证据。不需要账户、API 密钥、Figma 文件、全局安装或守护进程。
为您的编码代理保留工作流：
```bash
npx skills add memi-design/memi --skill audit-frontend-design
```
然后询问：
> 在编辑此前端之前进行审计。优先修复对用户最重要的五个问题。
| 关注的技能 | 使用场景 |
| --- | --- |
| `audit-frontend-design` | 在更改 UI 之前查找界面风险 |
| `remember-design-system` | 加载紧凑的产品系统上下文 |
| `enforce-design-ci` | 使用确定性证据控制拉取请求 |
| `build-swiftui-interface` | 构建和验证原生 Apple 接口 |
与 [shadcn 注册表](https://ui.shadcn.com/docs/registry/getting-started) 和 [v0 设计系统](https://v0.app/docs/design-systems) 兼容。
如果 Memi 在您的项目中捕获到真正的界面问题，[给存储库加星标](https://github.com/memi-design/memi) 并 [分享发现](https://github.com/memi-design/memi/discussions/categories/show-and-tell)。这是决定下一步改进的最有用的信号。
## Memi 捕获的内容
| 信号 | 示例证据 |
| --- | --- |
| 可访问性 | 缺少标签、减少运动的回退、焦点和对比度风险 |
| 界面制作 | 弱层次结构、间距漂移、脆弱的响应行为 |
| 产品状态 | 缺少加载、空、错误、成功和权限状态 |
| 设计系统 | 令牌漂移、原始值、不一致的组件使用 |
| 路由和组件 | 应用程序图、重复模式、风险更改表面 |
| 拉取请求 | 新债务仅限、SARIF 注释、步骤摘要、HTML 报告 |
第一个命令默认是只读的。具有写权限的脚手架和 Figma 操作是单独的、明确的工作流。
## 工作原理
1. **检查** - 从源代码、路由、样式和本地设计系统文件中构建证据图。
2. **发现** - 报告具有严重性、置信度、来源和 `file:line` 的规范问题。
3. **纠正** - 让人类或编码代理进行范围更改。
4. **验证** - 重新运行相同的命令并比较证据。
在确定性 CI 执行路径中不使用 LLM。
## 选择您的集成
| 表面 | 从这里开始 | 最适合 |
| --- | --- | --- |
| 一次性 CLI 审计 | `npx -y @memi-design/cli@2.6.4 diagnose . --no-write` | 在不安装的情况下试用 Memi |
| 全局 CLI | `npm i -g @memi-design/cli` | 每天本地使用 |
| 代理技能 | `npx skills add memi-design/memi --skill audit-frontend-design` | Codex、Claude、Cursor 和兼容的代理 |
| GitHub 操作 | `uses: memi-design/memi@ec4d804220bfbf08be810ceb692a338cf186e794` | 拉取请求设计 CI |
| MCP 服务器 | `memi mcp start --no-figma` | 任何 MCP 客户端 |
| Studio | `brew install --cask memi-design/memi/memi-studio` | 监督 macOS 工作流 |
CLI 和专注的技能是主要的。Studio、Figma、研究、脚手架、注册表和更大的工具路由器是更深层次的路径。
## 设计 CI
固定发布提交，以便每个拉取请求都运行相同的代码：
```yaml
name: design
on: [pull_request]
permissions:
contents: read
jobs:
memi:
runs-on: ubuntu-latest
permissions:
contents: read
security-events: write
steps:
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
fetch-depth: 0
- uses: memi-design/memi@ec4d804220bfbf08be810ceb692a338cf186e794 # v2.6.4
with:
version: "2.6.4"
report: true
upload-sarif: true
```
操作添加代码扫描注释、步骤摘要和 `memi-design-health` 工件。现有的债务可以基准，而新的债务会失败。
[GitHub 操作指南](docs/GITHUB_ACTION_MARKETPLACE.md) · [CI 食谱](docs/CI_RECIPES.md) · [团队部署](docs/TEAM_ROLLOUT.md)
## 代理和 MCP 设置
安装一个完整的项目套件：
```bash
memi agent install codex --project .
memi agent install claude-code --project .
memi agent install cursor --project .
memi agent install grok-build --project .
```
在没有 Figma 的情况下启动本地 MCP 服务器：
```bash
memi mcp start --no-figma
```
```json
{
"mcpServers": {
"memoire": {
"command": "memi",
"args": ["mcp", "start", "--no-figma"]
}
}
}
```
Codex 插件市场：
```bash
codex plugin marketplace add memi-design/memi --ref main --sparse .agents/plugins --sparse plugins/memoire
```
[代理堆栈指南](docs/AGENT_STACKS.md) · [复制粘贴食谱](docs/AGENT_RECIPES.md) · [完整技能路由器](skills/memoire-design-tooling/SKILL.md)
## 检验证明
- [设计沙盒](https://github.com/memi-design/design-sandbox) - 可运行的 Next.js、Tailwind、shadcn、MCP 和代理技能集成。
- [发布门控](docs/RELEASE_GATES.md) - 包、来源、干净安装、MCP、插件、 二进制文件和公共表面检查。
- [当前发布真相](docs/CURRENT_RELEASE.md) - npm、GitHub、操作、Studio 和网站版本的单一来源。
- [审计报告](docs/audits/) - 时间戳发现、证据缺口、分数上限和所有者。
- [`llms.txt`](llms.txt) - 紧凑的机器可读产品地图。
## 信任默认值
- 默认只读审计
- 没有 npm 安装时生命周期脚本
- 首次审计不需要账户或 API 密钥
- 没有源代码上传或隐蔽的遥测
- Figma 安装和连接是明确的
- 代理套件写入支持 `--dry-run --json`
- 不变的 Action 固定和发布来源
- [NOTICE](NOTICE) 中记录的 MIT 核心和第三方边界
## 社区
- [提问](https://github.com/memi-design/memi/discussions/categories/q-a)
- [展示 Memi 发现的内容](https://github.com/memi-design/memi/discussions/categories/show-and-tell)
- [报告错误](https://github.com/memi-design/memi/issues/new?template=bug_report.md)
- [请求功能](https://github.com/memi-design/memi/issues/new?template=feature_request.md)
- [贡献](CONTRIBUTING.md)
有用的贡献包括可复制的审计固定装置、框架适配器、技能改进、可访问的 UI 案例、着色器和运动检查以及真实的前后报告。
## 更多命令
<details>
<summary>CLI 参考</summary>
| 命令 | 它执行的操作 |
| --- | --- |
| `memi diagnose [target]` | 应用程序质量图和基于文件的发现 |
| `memi ux audit [target]` | UX 原则和产品状态风险 |
| `memi craft audit [target]` | 层次结构、节奏、约定和响应式批评 |
| `memi tokens --from <path>` | 提取令牌、别名、模式和漂移 |
| `memi agent brief . --json` | UI 工作前紧凑的证据合同 |
| `memi scaffold component <Name> --json` | 干运行原子设计脚手架 |
| `memi ios brief --json` | Apple 平台设计简介 |
| `memi shadcn export --out public/r` | 导出 shadcn 兼容的注册表 |
| `memi research design --json` | 研究到设计包 |
| `memi ci` | 基线感知的拉取请求门控 |
| `memi mcp start --no-figma` | 本地 MCP 服务器 |
</details>
## 无需 npm 安装
```bash
curl -fsSL https://memoire.cv/install.sh | sh
brew install memi-design/memi/memoire
docker run --rm -it -v "$PWD:/work" -w /work ghcr.io/memi-design/memi --help
```
## 许可证
Studio 接口引用和适配的组件包括 Hermes WebUI 和 MIT Warp UI 框架边界围绕 `warpui_core` 和 `warpui`；Warp AGPL 应用程序和客户端代码未复制到 Memi。
MIT。有关可选适配器和完整的第三方属性，请参见 [NOTICE](NOTICE)。
连接信息
猜你喜欢
暂无推荐服务器