# adm

**Repository Path**: mier520/adm

## Basic Information

- **Project Name**: adm
- **Description**: agent数据管理（agent data manager）工具，解决skills执行产生内容文件散乱的问题，提供统一的管理维护功能
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-06-23
- **Last Updated**: 2026-06-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# ADM - Agent Data Management

ADM 是面向 Agent/Skill 工作流的本地数据管理 CLI。它在用户项目目录中创建 `.adm/` 仓库，用 SQLite 主索引和可读快照管理文件、目录、文本、JSON、运行记录、血缘、项目图谱、检索、导出和可视化结果。

## 当前实现

- 技术栈：Node.js / TypeScript
- 包名：`@adm/cli`
- CLI：`adm`
- 数据目录：`.adm/`
- 主索引：`.adm/index.db`
- Skill 接入文件：`.adm/SKILL_ACCESS.md`
- 可读快照：`metadata.json`、`lineage.json`、`manifest.json`、collection 快照

## 核心能力

- 初始化：`adm init`
- 存储文件和目录：`adm store`、`adm store-dir`
- 存储文本、字符串、stdin、JSON：`adm put`、`adm memo`、`adm tmp`、`adm final`
- 低 token 批量写入：`adm batch --stdin`
- 检索和解释匹配：`adm search --explain`
- 获取数据副本：`adm get`
- 查看元数据：`adm info`
- 血缘记录和查询：`adm lineage`、`adm lineage record`
- 处理记录复用：`adm operations search/info/reuse`
- 项目图谱：`adm collection`、`adm entity`、`adm relation`、`adm outline`
- 查询与分页清单：`adm query`、`adm list`
- 导出：`adm export get/files/query/collection/relation/manifest`
- 可视化：`adm visualize lineage/relation/outline/operation/dependencies/mindmap/export`
- 项目剖面、检查和视图：`adm profile`、`adm check`、`adm view`
- 生命周期和维护：`adm lifecycle list`、`adm gc`、`adm doctor`、`adm migrate`
- SQLite 状态、备份恢复、契约校验：`adm sqlite status`、`adm backup`、`adm restore`、`adm validate-contract`

## 安装与运行

```bash
npm install
npm run build
node dist/cli.js init
node dist/cli.js status
```

安装为 CLI：

```bash
npm install -g .
adm init
adm status
```

## 快速示例

```bash
adm init
adm put --text "阶段发现：A 指标异常" --title "阶段发现" --id-only
adm store ./outputs/report.md --title "Q2 分析报告" --tags "Q2,report" --operations "read,summary,analysis"
adm search --query "Q2 report" --explain
adm get <data-id> --output ./temp
adm lineage <data-id> --format mermaid
```

项目化组织：

```bash
adm collection create --type analysis-project --title "Q2 Analysis"
adm entity put --collection <collection-id> --type dataset --title "Sales Dataset" --data <data-id>
adm relation add --collection <collection-id> --from-type entity --from <entity-a> --type derives --to-type entity --to <entity-b>
adm profile apply <collection-id> --profile analysis-project
adm check <collection-id>
adm view <collection-id> --by relation
```

声明式接入：

```text
本项目使用 ADM，请按 .adm/SKILL_ACCESS.md 记录、检索、复用、追踪、组织和导出数据。
```

## 文档

| 文档 | 内容 |
|------|------|
| [docs/USAGE.md](./docs/USAGE.md) | CLI 命令手册 |
| [docs/COMMAND_EXAMPLES.md](./docs/COMMAND_EXAMPLES.md) | 覆盖主要功能的端到端示例 |
| [docs/ARCHITECTURE.md](./docs/ARCHITECTURE.md) | 架构、数据模型、数据流与维护约定 |
| [docs/SKILL_ACCESS.md](./docs/SKILL_ACCESS.md) | Skill/Agent 接入规则 |
| [docs/DESIGN.md](./docs/DESIGN.md) | ADM 3 本地目录与索引设计 |

## 测试

```bash
npm test
```