@luluyun/automd 1.0.0 → 1.0.2

package/README.md

@@ -1,194 +1,65 @@
 # AutoMD CLI
 
-这是一个基于 Bun + TypeScript 的终端 AI CLI，已经按“可跨电脑同步部署”的目标整理为一个可直接拉取的私有仓库版本。
-
-仓库当前不仅包含核心 CLI 源码，还包含你当前使用的 LAMMPS 相关代理、技能、知识库核心内容、插件市场快照，以及项目级配置，目标是在不同电脑上尽量保持一致的行为。
-
-## 适用场景
+AutoMD 是面向 LAMMPS / 分子动力学工作的终端 AI 助手。npm 包内置默认 agents、skills、templates 和 knowledge，用户安装后只需要运行 `automd`，再按初始化向导填写模型 API Key。
 
-- 作为日常使用的 CLI 主仓库
-- 在不同电脑间同步相同的配置、技能和知识资产
-- 作为 LAMMPS 工作流、知识库和插件能力的统一备份基线
+## 安装
 
-## 当前已纳入仓库的内容
-
-### 1. 核心源码与构建配置
-
-- `src/`
-- `packages/`
-- `scripts/`
-- `package.json`
-- `bun.lock`
-- `tsconfig.json`
-- `tsconfig.base.json`
-- `vite.config.ts`
-- `build.ts`
-- `.github/`
-
-### 2. CLI 共享配置
-
-- `.angsheng/settings.json`
-- `.angsheng/settings.local.json`
-- `.angsheng/providers/`
-- `.angsheng/provider-configs/`
-- `.angsheng/agents/`
-- `.angsheng/skills/`
-- `.angsheng/templates/`
-
-### 3. 插件与插件市场快照
-
-- `.angsheng/plugins/known_marketplaces.json`
-- `.angsheng/plugins/marketplaces/claude-plugins-official/`
-
-说明：
-
-- 插件市场内容已经直接 vendored 到仓库内，不依赖旧机器上的绝对路径
-- `known_marketplaces.json` 已改为仓库内相对路径，便于跨机器同步
-
-### 4. 知识库核心内容
-
-- `knowledge/rules/`
-- `knowledge/memory/`
-- `knowledge/templates/`
-- `knowledge/cases/INDEX.md`
-- `knowledge/cases/CASE_METADATA.md`
-- `knowledge/cases/case-family-index.md`
-- `knowledge/cases/structure-index.md`
-- `knowledge/cases/notes/`
-- `knowledge/cases/templates/`
-- `knowledge/cases/paper-reproduction/` 中保留的脚本、输入模板、说明和结果文档
-
-### 5. 项目文档
-
-- `docs/`
-- `README_EN.md`
-- `NOTICE.md`
-- `SECURITY.md`
-
-## 有意忽略的内容
-
-这些内容默认不进入仓库，因为它们要么是运行态数据，要么是体积过大、价值较低，或者不适合长期版本化。
-
-### 1. 运行态目录
-
-- `.angsheng/sessions/`
-- `.angsheng/backups/`
-- `.angsheng/projects/`
-- `.angsheng/shell-snapshots/`
-- `.angsheng/teams/`
-- `.angsheng/telemetry/`
-- `.lammps-project/`
-- `.migration-backups/`
-- `benchmarking/`
-- `project-memory/`
-- `scratchpad/`
-- `work/`
-
-### 2. 大型原始案例与模型资产
-
-- `knowledge/cases/raw/`
-- `knowledge/cases/paper-reproduction/**/*.eam*`
-- `knowledge/cases/paper-reproduction/**/*.lammpstrj`
-- `knowledge/cases/paper-reproduction/**/*.data`
-- `knowledge/cases/paper-reproduction/**/*.plt`
-- `knowledge/cases/paper-reproduction/**/*.csv`
-- `knowledge/cases/paper-reproduction/**/log.lammps`
-
-### 3. 通用大文件与本地产物
-
-- `*.zip`
-- `*.7z`
-- `*.sqlite`
-- 根目录下的 `/*.lmp`
-- 根目录下的 `/*.lammpstrj`
-- 根目录下的 `/*.data`
-
-### 4. 当前明确未同步的内容
-
-- `knowledge/reports/`
-
-## 快速开始
-
-建议环境：
-
-- Bun `>= 1.3.x`
-- Node.js 用于运行构建后的 `dist/cli-node.js`
-
-安装依赖：
+要求：Node.js `>= 20.0.0`。
 
 ```bash
-bun install
+npm install -g @luluyun/automd
 ```
 
-开发模式启动：
+如果系统把全局 npm 包安装到 `/usr/lib/node_modules` 或 `/usr/local/lib/node_modules`，普通用户可能没有写权限；这类系统级 Node 安装请使用：
 
 ```bash
-bun run dev
+sudo npm install -g @luluyun/automd
 ```
 
-构建：
+安装后直接运行：
 
 ```bash
-bun run build
+automd
 ```
 
-运行构建产物：
+不需要安装 Bun，也不需要用户手动配置环境变量。
 
-```bash
-node dist/cli-node.js
-```
+## 首次启动
 
-## 常用命令
+在任意项目目录运行 `automd`。如果当前项目没有可用的 `.angsheng/settings.json`，AutoMD 会自动进入初始化向导：
 
-```bash
-aura
-aura-bun
-aura update
-bun run lammps
-bun run dashboard
-```
+1. 选择模型服务商。
+2. 输入 API Key。
+3. AutoMD 写入当前项目的 `.angsheng/settings.json`。
+4. AutoMD 自动把 `.angsheng/settings.json` 加入当前项目 `.gitignore`。
+5. 初始化完成后继续进入 AutoMD。
 
-## 与 LAMMPS 相关的常用脚本
+内置预设包括 MiniMax、DeepSeek、百炼、智谱和自定义兼容接口。初始化不会联网校验 key；如果 key、base URL 或模型名有误，会在首次模型调用时报错。
+
+## 常用命令
 
 ```bash
-bun run lammps
-bun run lammps:init-state
-bun run lammps:log-sections
-bun run lammps:maintain-knowledge
-bun run test:lammps-cli
-bun run engine:run
-bun run engine:mcp
+automd
+automd setup
+automd lookup "LAMMPS units metal 的时间单位是什么？"
+automd build "写一个金属体系拉伸的 LAMMPS 输入脚本"
+automd execute --input in.lammps --workdir runs/test --dry-run
 ```
 
-## 同步策略
-
-如果你的目标是“不同电脑上的 CLI 尽量一致”，建议遵循以下规则：
+## 项目配置
 
-1. 所有源码、共享配置、技能、知识库索引、插件市场快照都提交到仓库
-2. 所有运行态目录、临时目录、日志、原始大模型/大案例文件不要提交
-3. 依赖版本必须以 `bun.lock` 为准
-4. 新电脑部署后优先执行 `bun install`，不要先手动改动目录结构
-5. 如果新增了真正需要共享的技能、模板、插件配置或知识索引，应提交到仓库
-6. 如果只是单次运行产物、实验缓存、日志或分析中间件输出，不应提交
+- 配置文件保存在用户运行 `automd` 时所在项目的 `.angsheng/settings.json`。
+- API Key 只写入项目配置文件，不要求用户设置 shell 环境变量。
+- `.angsheng/settings.json` 会被自动加入 `.gitignore`。
+- 用户项目里的 `.angsheng/agents` 和 `.angsheng/skills` 可以覆盖 npm 包内置的同名 agent / skill。
+- npm 包内置 `knowledge/` 是默认知识库；用户项目自己的 knowledge 可作为补充或覆盖来源。
 
 ## 安全提醒
 
-当前仓库为了跨电脑保持一致，已经纳入部分实际配置与 provider 配置内容。
-
-这意味着：
-
-- 私有仓库内可以直接恢复当前 CLI 的大部分配置状态
-- 但仓库的访问权限必须严格控制
-- 更稳妥的长期方案仍然是：仓库保存结构，敏感密钥改用环境变量或系统密钥存储
-
-## 文档入口
-
-- 项目文档：[`docs/`](./docs/)
-- 英文说明：[`README_EN.md`](./README_EN.md)
-- 来源与归属说明：[`NOTICE.md`](./NOTICE.md)
-- 安全说明：[`SECURITY.md`](./SECURITY.md)
+不要把 `.angsheng/settings.json` 提交到 Git。这个文件包含模型服务商 API Key，AutoMD 初始化时会自动写入 `.gitignore`，但已有仓库仍建议在提交前确认一次。
 
-## 备注
+## 故障排查
 
-- 当前仓库已经是“精简但可部署”的同步基线，不是原始工作目录的无差别镜像
-- 如果后续要扩大备份范围，优先增加高价值文本资产，不要重新把大型原始模型文件放回 Git
+- `Unsupported engine`：请升级到 Node.js 20 或更高版本。
+- `EACCES`：说明当前系统的全局 npm 安装目录没有写权限。如果全局目录在 `/usr/lib/node_modules` 或 `/usr/local/lib/node_modules`，请改用 `sudo npm install -g @luluyun/automd`。
+- 模型调用失败：检查 `.angsheng/settings.json` 中的 key、base URL 和 model 是否正确。

package/README_EN.md

@@ -1,36 +1,65 @@
-# Agent Aura
+# AutoMD CLI
 
-Agent Aura is a terminal-first AI coding assistant built with Bun and TypeScript.
+AutoMD is a terminal AI assistant for LAMMPS and molecular dynamics workflows. The npm package ships with bundled default agents, skills, templates, and knowledge assets. After installation, users only need to run `automd` and follow the setup wizard.
 
-## Quick Start
+## Install
+
+Requirement: Node.js `>= 20.0.0`.
+
+```bash
+npm install -g @luluyun/automd
+```
+
+If your system installs global npm packages under `/usr/lib/node_modules` or `/usr/local/lib/node_modules`, your user may not have write permission. For this system-level Node setup, use:
 
 ```bash
-bun install
-bun run dev
+sudo npm install -g @luluyun/automd
 ```
 
-The development entrypoint launches the interactive TUI. For a production build:
+Then run:
 
 ```bash
-bun run build
-node dist/cli-node.js
+automd
 ```
 
-## Commands
+Bun is not required, and users do not need to configure shell environment variables manually.
+
+## First Run
+
+Run `automd` inside any project directory. If the current project does not have a usable `.angsheng/settings.json`, AutoMD starts the initialization wizard automatically:
+
+1. Choose a model provider.
+2. Enter the API key.
+3. AutoMD writes `.angsheng/settings.json` in the current project.
+4. AutoMD adds `.angsheng/settings.json` to the project `.gitignore`.
+5. AutoMD continues into the main CLI after setup.
+
+Built-in presets include MiniMax, DeepSeek, Alibaba Bailian, Zhipu, and custom compatible endpoints. Setup does not validate the key over the network; invalid keys, base URLs, or model names will fail on the first model call.
+
+## Common Commands
 
 ```bash
-aura
-aura-bun
-aura update
+automd
+automd setup
+automd lookup "What is the time unit for LAMMPS units metal?"
+automd build "Write a LAMMPS tensile input script for a metal system"
+automd execute --input in.lammps --workdir runs/test --dry-run
 ```
 
-## Docs
+## Project Configuration
+
+- Configuration is stored in `.angsheng/settings.json` under the project where `automd` is launched.
+- API keys are written to the project config file; users do not need to set shell environment variables.
+- `.angsheng/settings.json` is automatically added to `.gitignore`.
+- Project-level `.angsheng/agents` and `.angsheng/skills` can override bundled agents and skills with the same names.
+- Bundled `knowledge/` is the default knowledge base; project knowledge can extend or override it.
+
+## Security
 
-- Project docs: [docs/](./docs/)
-- Project notes: [Friends.md](./Friends.md)
-- Provenance and attribution: [NOTICE.md](./NOTICE.md)
+Do not commit `.angsheng/settings.json` to Git. It contains model provider API keys. AutoMD adds it to `.gitignore` during setup, but it is still worth checking before committing.
 
-## Notes
+## Troubleshooting
 
-- Bun `>= 1.3.11` is recommended.
-- Compatibility-oriented identifiers such as `CLAUDE_CODE_*` environment variables remain in the codebase to avoid breaking integrations.
+- `Unsupported engine`: upgrade to Node.js 20 or newer.
+- `EACCES`: the current global npm install directory is not writable. If it is under `/usr/lib/node_modules` or `/usr/local/lib/node_modules`, use `sudo npm install -g @luluyun/automd`.
+- Model call failed: check the key, base URL, and model in `.angsheng/settings.json`.