@ecc-hgy/ae 0.2.0 → 0.3.0

package/README.md

@@ -10,7 +10,6 @@ Agentic Engineering is a lightweight personal software lifecycle method: SDD rec
 ```bash
 cd /your/project
 npx @ecc-hgy/ae setup
-# Optional: edit config/ae-rules.md
 npx @ecc-hgy/ae init "one-line project goal"
 ```
 
@@ -18,23 +17,27 @@ npx @ecc-hgy/ae init "one-line project goal"
 
 - `skills/` -> `.claude/skills/`
 - `skills/` -> `.codex/skills/`
-- `templates/ae-rules.md` -> `config/ae-rules.md`
 
-`ae init` creates the platform-neutral project skeleton, renders entry files, and syncs the contents of `config/ae-rules.md` into the managed `AE:RULES` block in `AGENTS.md` and `CLAUDE.md`.
+`ae init` creates the platform-neutral project skeleton and renders entry files. Project-specific rules live directly in `AGENTS.md`.
 
 ## CLI
 
 ```bash
 ae setup
 ae init "one-line project goal"
-ae init "goal" --rules /path/to/rules.md
 ae --help
 ae --version
 ```
 
-Both commands are idempotent. They create missing files, skip existing files, and never overwrite user edits outside the managed `AE:RULES` block. There is no `--force` mode.
+Both commands are idempotent. They create missing files, skip existing files, and never overwrite existing entry files. There is no `--force` mode.
 
-`ae init` requires `ae setup` to have run first. This keeps the two-step workflow explicit so you can edit `config/ae-rules.md` before it is injected.
+`ae init` requires `ae setup` to have run first. This keeps asset installation explicit before skeleton creation.
+
+## Single Source Of Truth
+
+- `AGENTS.md` is the canonical project instructions file.
+- `CLAUDE.md` is a short pointer to `AGENTS.md`; do not maintain a separate copy there.
+- All project-specific rules live in `AGENTS.md` under `## Project-Specific Rules`.
 
 ## Platform Scope
 
@@ -90,7 +93,7 @@ The two hard gates are:
 bin/        npm executable entry
 src/        zero-dependency CLI implementation
 skills/     Selected Agentic Engineering skills
-templates/  Entry file templates and the ae-rules.md starter
+templates/  Entry file templates
 docs/       User-facing methodology docs
 design/     Design records for this repository
 tests/      node:test coverage for CLI behavior
@@ -100,8 +103,9 @@ tests/      node:test coverage for CLI behavior
 
 1. Stage 2: npm CLI asset distribution with `init` and `ingest-mother`. Superseded by v0.2.
 2. v0.2: split CLI into `setup` + `init`, remove slash command assets, and move rule sync into `ae init`.
-3. Stage 3: design `ae update` for skill/template upgrades and implement `ae index-rebuild`.
-4. Add CI and Windows path validation before broader distribution.
+3. v0.3: remove rules injection; make `AGENTS.md` the single source of truth and `CLAUDE.md` a pointer.
+4. Stage 3: design `ae update` for skill/template upgrades and implement `ae index-rebuild`.
+5. Add CI and Windows path validation before broader distribution.
 
 ## Limits
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ecc-hgy/ae",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Agentic Engineering is a lightweight personal software lifecycle method: SDD records what to build, TDD drives how to prove it works.",
   "type": "module",
   "bin": {

package/src/cli.js

@@ -5,9 +5,9 @@ import { packageRoot } from './utils/paths.js';
 const HELP = `Usage: ae <command> [options]
 
 Commands:
-  setup                Install skills to .claude/.codex and drop a config/ae-rules.md template.
-  init [goal]          Create spec/ skeleton, render entry files, sync AE:RULES block from
-                       config/ae-rules.md. Requires \`ae setup\` to have run.
+  setup                Install skills to .claude/.codex.
+  init [goal]          Create spec/ skeleton and render entry files.
+                       Requires \`ae setup\` to have run.
 
 Options:
   -h, --help     Show help
@@ -15,7 +15,6 @@ Options:
 
 Typical workflow:
   ae setup
-  [optional] edit config/ae-rules.md
   ae init "<one-line project goal>"`;
 
 export async function run(argv = []) {

package/src/commands/init.js

@@ -1,6 +1,6 @@
-import { mkdir, readFile, stat } from 'node:fs/promises';
+import { mkdir, stat } from 'node:fs/promises';
 import path from 'node:path';
-import { createDirectories, renderEntryFiles, syncRulesBlock, RulesMarkerError } from '../skeleton.js';
+import { createDirectories, renderEntryFiles } from '../skeleton.js';
 import { templatesPath } from '../utils/paths.js';
 import { formatInitReport } from '../utils/report.js';
 
@@ -10,9 +10,7 @@ const HELP = `Usage: ae init [goal] [options]
 
 Options:
   --target <path>  Initialize this project directory. Defaults to cwd.
-  --rules <path>   Read AE:RULES content from this markdown file.
-                   Defaults to <target>/config/ae-rules.md when present.
-  --dry-run        Show what would be created or synced without writing files.
+  --dry-run        Show what would be created without writing files.
   -h, --help       Show help`;
 
 export async function run(argv = []) {
@@ -51,16 +49,10 @@ export async function run(argv = []) {
     created.push(...entries.created);
     skipped.push(...entries.skipped);
 
-    const rules = await syncRules(target, options);
-
-    console.log(formatInitReport({ created, skipped, target, rules, dryRun: options.dryRun }));
+    console.log(formatInitReport({ created, skipped, target, dryRun: options.dryRun }));
     return 0;
   } catch (error) {
-    if (error instanceof RulesMarkerError) {
-      console.error(`AE init failed: ${error.message}`);
-    } else {
-      console.error(`AE init failed: ${error instanceof Error ? error.message : String(error)}`);
-    }
+    console.error(`AE init failed: ${error instanceof Error ? error.message : String(error)}`);
     process.exitCode = 1;
     return 1;
   }
@@ -69,7 +61,6 @@ export async function run(argv = []) {
 function parseArgs(argv) {
   const options = {
     target: undefined,
-    rules: undefined,
     goalParts: [],
     dryRun: false,
     help: false,
@@ -88,13 +79,6 @@ function parseArgs(argv) {
       }
       options.target = value;
       index += 1;
-    } else if (arg === '--rules') {
-      const value = argv[index + 1];
-      if (!value) {
-        throw new Error('--rules requires a path');
-      }
-      options.rules = value;
-      index += 1;
     } else if (arg.startsWith('-')) {
       throw new Error(`Unknown option for init: ${arg}`);
     } else {
@@ -104,7 +88,6 @@ function parseArgs(argv) {
 
   return {
     target: options.target,
-    rules: options.rules,
     dryRun: options.dryRun,
     help: options.help,
     goal: options.goalParts.length > 0 ? options.goalParts.join(' ') : undefined,
@@ -134,41 +117,6 @@ async function hasInstalledAssets(target) {
   );
 }
 
-async function syncRules(target, options) {
-  const rulesPath = options.rules
-    ? path.resolve(process.cwd(), options.rules)
-    : path.join(target, 'config', 'ae-rules.md');
-
-  const rulesInfo = await statMaybe(rulesPath);
-  if (!rulesInfo) {
-    if (options.rules) {
-      throw new Error(`rules file does not exist: ${rulesPath}`);
-    }
-    return 'skipped (no rules file)';
-  }
-
-  if (rulesInfo.isDirectory()) {
-    throw new Error(`expected a file, got directory: ${rulesPath}`);
-  }
-  if (!rulesInfo.isFile()) {
-    throw new Error(`expected a file: ${rulesPath}`);
-  }
-
-  const rulesContent = await readFile(rulesPath, 'utf8');
-  const agents = path.join(target, 'AGENTS.md');
-  const claude = path.join(target, 'CLAUDE.md');
-  const agentsExists = await exists(agents);
-  const claudeExists = await exists(claude);
-
-  if (options.dryRun && (!agentsExists || !claudeExists)) {
-    return 'would sync';
-  }
-
-  await syncRulesBlock(agents, rulesContent, { dryRun: options.dryRun });
-  await syncRulesBlock(claude, rulesContent, { dryRun: options.dryRun });
-  return options.dryRun ? 'would sync' : 'synced';
-}
-
 async function statMaybe(value) {
   try {
     return await stat(value);
@@ -180,10 +128,6 @@ async function statMaybe(value) {
   }
 }
 
-async function exists(value) {
-  return Boolean(await statMaybe(value));
-}
-
 async function isDirectory(value) {
   const current = await statMaybe(value);
   return Boolean(current?.isDirectory());

package/src/commands/setup.js

@@ -1,7 +1,7 @@
 import { mkdir, stat } from 'node:fs/promises';
 import path from 'node:path';
-import { copyFileIdempotent, copyTreeIdempotent } from '../utils/copy.js';
-import { skillsPath, templatesPath } from '../utils/paths.js';
+import { copyTreeIdempotent } from '../utils/copy.js';
+import { skillsPath } from '../utils/paths.js';
 import { formatSetupReport } from '../utils/report.js';
 
 const HELP = `Usage: ae setup [options]
@@ -45,14 +45,6 @@ export async function run(argv = []) {
       skipped.push(...result.skipped.map((item) => toDisplayPath(path.join(group.prefix, item))));
     }
 
-    const rulesResult = await copyFileIdempotent(
-      templatesPath('ae-rules.md'),
-      path.join(target, 'config', 'ae-rules.md'),
-      { dryRun: options.dryRun },
-    );
-    created.push(...rulesResult.created.map((item) => toDisplayPath(path.join('config', item))));
-    skipped.push(...rulesResult.skipped.map((item) => toDisplayPath(path.join('config', item))));
-
     console.log(formatSetupReport({ created, skipped, target, dryRun: options.dryRun }));
     return 0;
   } catch (error) {

package/src/skeleton.js

@@ -1,9 +1,6 @@
 import { mkdir, readFile, stat, writeFile } from 'node:fs/promises';
 import path from 'node:path';
 
-export const RULES_BEGIN = '<!-- AE:RULES:BEGIN -->';
-export const RULES_END = '<!-- AE:RULES:END -->';
-const RULES_COMMENT = '<!-- 由 ae init 从 config/ae-rules.md 或 --rules 指定文件同步,勿手改 -->';
 const DEFAULT_DRY_RUN = false;
 
 const SKELETON_DIRS = [
@@ -32,13 +29,6 @@ const ENTRY_FILES = [
   path.join('spec', 'INDEX.md'),
 ];
 
-export class RulesMarkerError extends Error {
-  constructor(message) {
-    super(message);
-    this.name = 'RulesMarkerError';
-  }
-}
-
 export async function createDirectories(target, options = {}) {
   const dryRun = Boolean(options.dryRun ?? DEFAULT_DRY_RUN);
   const created = [];
@@ -112,82 +102,12 @@ export async function renderEntryFiles(target, templateRoot, options = {}) {
   return { created, skipped, updated };
 }
 
-export async function syncRulesBlock(targetFile, rulesContent, options = {}) {
-  const dryRun = Boolean(options.dryRun ?? DEFAULT_DRY_RUN);
-  const content = await readFile(targetFile, 'utf8');
-  const ranges = findRulesRanges(content, targetFile);
-  const block = buildRulesBlock(rulesContent);
-  const created = [];
-  const skipped = [];
-  const updated = [];
-  const display = path.basename(targetFile);
-
-  if (ranges.length === 0) {
-    const next = content.endsWith('\n') ? `${content}\n${block}` : `${content}\n\n${block}`;
-    if (next === content) {
-      skipped.push(display);
-      return { created, skipped, updated };
-    }
-    created.push(`${display}#AE:RULES`);
-    if (!dryRun) {
-      await writeFile(targetFile, next);
-    }
-    return { created, skipped, updated };
-  }
-
-  const [{ start, end }] = ranges;
-  const next = `${content.slice(0, start)}${block}${content.slice(end)}`;
-
-  if (next === content) {
-    skipped.push(`${display}#AE:RULES`);
-    return { created, skipped, updated };
-  }
-
-  updated.push(`${display}#AE:RULES`);
-  if (!dryRun) {
-    await writeFile(targetFile, next);
-  }
-
-  return { created, skipped, updated };
-}
-
-export function buildRulesBlock(rulesContent) {
-  const normalized = rulesContent.endsWith('\n') ? rulesContent : `${rulesContent}\n`;
-  return `${RULES_BEGIN}\n${RULES_COMMENT}\n${normalized}${RULES_END}\n`;
-}
-
 function renderTemplate(template, replacements) {
   return template
     .replaceAll('{{PROJECT_NAME}}', replacements.projectName)
     .replaceAll('{{PROJECT_GOAL}}', replacements.projectGoal);
 }
 
-function findRulesRanges(content, targetFile) {
-  const beginMatches = [...content.matchAll(new RegExp(escapeRegExp(RULES_BEGIN), 'g'))];
-  const endMatches = [...content.matchAll(new RegExp(escapeRegExp(RULES_END), 'g'))];
-
-  if (beginMatches.length !== endMatches.length || beginMatches.length > 1) {
-    throw new RulesMarkerError(`malformed AE:RULES markers in ${targetFile}`);
-  }
-
-  if (beginMatches.length === 0) {
-    return [];
-  }
-
-  const start = beginMatches[0].index;
-  const end = endMatches[0].index + RULES_END.length;
-  if (start > endMatches[0].index) {
-    throw new RulesMarkerError(`malformed AE:RULES markers in ${targetFile}`);
-  }
-
-  let rangeEnd = end;
-  if (content.slice(rangeEnd, rangeEnd + 1) === '\n') {
-    rangeEnd += 1;
-  }
-
-  return [{ start, end: rangeEnd }];
-}
-
 async function exists(value) {
   try {
     await stat(value);
@@ -203,7 +123,3 @@ async function exists(value) {
 function normalizeRelative(value) {
   return value.split(path.sep).join('/');
 }
-
-function escapeRegExp(value) {
-  return value.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
-}

package/src/utils/report.js

@@ -5,17 +5,16 @@ export function formatSetupReport({ created, skipped, target, dryRun }) {
     `- ${installedLabel}: ${created.length} (${summarize(created)})`,
     `- Skipped: ${skipped.length} (${summarize(skipped)})`,
     `- Target: ${target}`,
-    `- Next: edit config/ae-rules.md (optional), then run \`ae init "<goal>"\`.`,
+    `- Next: run \`ae init "<goal>"\`.`,
   ].join('\n');
 }
 
-export function formatInitReport({ created, skipped, target, rules, dryRun }) {
+export function formatInitReport({ created, skipped, target, dryRun }) {
   const createdLabel = dryRun ? 'Would create' : 'Created';
   return [
     dryRun ? 'AE init dry run complete' : 'AE init complete',
     `- ${createdLabel}: ${created.length} (${summarize(created)})`,
     `- Skipped: ${skipped.length} (${summarize(skipped)})`,
-    `- Rules: ${rules}`,
     `- Target: ${target}`,
   ].join('\n');
 }

package/templates/entries/AGENTS.md

@@ -1,21 +1,24 @@
-# Project Goal
+# {{PROJECT_NAME}}
 
-{{PROJECT_GOAL}}
+> {{PROJECT_GOAL}}
 
-## R1 Progressive Loading
+## Project-Specific Rules
 
-Keep this file short because every agent session loads it. Do trivial work directly. For non-trivial product, architecture, implementation, or debug work, first load the relevant local guidance or skill, then proceed.
+<!-- 在这里写本项目的稳定规则,例如:
+     - 代码风格 / 注释语言
+     - 提交规范
+     - 协作偏好
+     这些规则会被 Claude Code / Codex 在每次 session 自动加载。
+     未来新规则直接追加到本段,不需要其他工具命令。 -->
 
-## Spec Landing Rules
+## Stack
 
-- SDD owns what to build; TDD owns how to prove it works.
-- After writing or changing anything under `spec/needs/<need-name>/`, update `spec/INDEX.md`.
-- If `spec/INDEX.md` cannot be updated confidently, run the future `index-rebuild` command or leave an explicit handoff note.
-- Do not write `prd.md` before requirement alignment.
-- Do not fix a bug before expected behavior is aligned.
+TODO: 简述项目技术栈与运行环境。
 
-## Project Specific Rules
+## Structure
 
-<!-- AE:PROJECT:BEGIN -->
-<!-- Add project-specific rules here. `ae init` manages AE:RULES separately. -->
-<!-- AE:PROJECT:END -->
+TODO: 简述目录结构,标注关键入口。
+
+## Operating Guidelines
+
+TODO: 简述代码、测试、提交、PR 的操作规范。

package/templates/entries/CLAUDE.md

@@ -1,21 +1,5 @@
-# Project Goal
+# {{PROJECT_NAME}}
 
-{{PROJECT_GOAL}}
+**Always read [AGENTS.md](./AGENTS.md) at the start of every session before doing any work.**
 
-## R1 Progressive Loading
-
-Keep this file short because every agent session loads it. Do trivial work directly. For non-trivial product, architecture, implementation, or debug work, first load the relevant local guidance or skill, then proceed.
-
-## Spec Landing Rules
-
-- SDD owns what to build; TDD owns how to prove it works.
-- After writing or changing anything under `spec/needs/<need-name>/`, update `spec/INDEX.md`.
-- If `spec/INDEX.md` cannot be updated confidently, run the future `index-rebuild` command or leave an explicit handoff note.
-- Do not write `prd.md` before requirement alignment.
-- Do not fix a bug before expected behavior is aligned.
-
-## Project Specific Rules
-
-<!-- AE:PROJECT:BEGIN -->
-<!-- Add project-specific rules here. `ae init` manages AE:RULES separately. -->
-<!-- AE:PROJECT:END -->
+This project's instructions, rules, structure, and operating guidelines are all defined in `AGENTS.md`.

package/templates/ae-rules.md

@@ -1,17 +0,0 @@
-# Project-Specific Rules
-
-<!-- 这个文件在 `ae init` 时会被读取,内容会注入到 AGENTS.md 与 CLAUDE.md 的
-     AE:RULES block 中。可以在 `ae setup` 之后、`ae init` 之前编辑。 -->
-
-## 通用约束
-
-- 例如:所有代码注释使用中文
-- 例如:提交信息遵循 Conventional Commits
-
-## 项目栈
-
-- 例如:Node.js 18+,TypeScript strict mode
-
-## 协作偏好
-
-- 例如:小步提交,每个 commit 必须包含测试