@zwbcoding/agent-nav 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 zwb
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,9 @@
+# @zwbcoding/agent-nav
+
+创建轻量 AI Agent 导航包。
+
+```bash
+npx @zwbcoding/agent-nav init my-project
+```
+
+该命令只创建基础目录和说明文件。

package/bin/agent-nav.js

@@ -0,0 +1,16 @@
+#!/usr/bin/env node
+
+import { init } from "../lib/init.js";
+
+const [command, target] = process.argv.slice(2);
+
+if (command === "init") {
+  try {
+    await init(target ?? ".");
+  } catch (error) {
+    console.error(`agent-nav: ${error.message}`);
+    process.exitCode = 1;
+  }
+} else {
+  console.log("Usage: agent-nav init <directory>");
+}

package/lib/init.js

@@ -0,0 +1,57 @@
+import { access, mkdir, readdir, writeFile } from "node:fs/promises";
+import path from "node:path";
+
+const directories = [
+  ["code", "存放完整项目代码。"],
+  ["docs", "存放所有项目文档。"],
+  ["docs/demand", "存放需求文档。"],
+  ["docs/test", "存放测试文档。"],
+  ["docs/design", "存放设计文档。"],
+  ["docs/meet", "存放会议记录。"],
+  ["docs/record", "存放项目记录。"],
+  ["deploy", "存放部署和运维相关记录。"],
+  ["deploy/log", "存放部署与运维日志。"],
+  ["deploy/env", "存放部署环境相关信息。"],
+  ["deploy/info", "存放部署与运维说明信息。"],
+  ["guide", "存放向导和索引文件。"],
+  ["agent", "存放不同 Coding Agent 的入口适配文件。"],
+  ["agent/codex", "存放 Codex 入口适配文件。"],
+  ["agent/claudecode", "存放 Claude Code 入口适配文件。"],
+  ["command", "存放自动化脚本或命令。"],
+  ["spec", "存放项目规约文件。"],
+  ["workflow", "存放可定制、可组合的工作流定义。"],
+  ["cli", "存放命令行交互相关内容。"],
+  ["data", "存放项目数据。"],
+  ["view", "可选目录，用于为用户提供界面向导。"]
+];
+
+export async function init(target) {
+  const root = path.resolve(target);
+
+  try {
+    await access(root);
+    if ((await readdir(root)).length > 0) {
+      throw new Error(`target is not empty: ${root}`);
+    }
+  } catch (error) {
+    if (error.code !== "ENOENT") throw error;
+  }
+
+  await mkdir(root, { recursive: true });
+  await writeFile(
+    path.join(root, "README.md"),
+    "# AI Agent 导航包\n\n用于汇聚项目资料，并通过统一目录向 AI 提供项目的最新进展、规约与当前情况。\n",
+    "utf8"
+  );
+
+  await Promise.all(
+    directories.map(async ([directory, description]) => {
+      const destination = path.join(root, directory);
+      const name = path.basename(directory);
+      await mkdir(destination, { recursive: true });
+      await writeFile(path.join(destination, "README.md"), `# ${name}\n\n${description}\n`, "utf8");
+    })
+  );
+
+  console.log(`Created AI agent navigation workspace: ${root}`);
+}

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@zwbcoding/agent-nav",
+  "version": "0.1.0",
+  "description": "Create a lightweight AI agent navigation workspace.",
+  "type": "module",
+  "bin": {
+    "agent-nav": "bin/agent-nav.js"
+  },
+  "files": [
+    "bin",
+    "lib",
+    "README.md",
+    "LICENSE"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "license": "MIT",
+  "keywords": [
+    "ai-agent",
+    "codex",
+    "claude-code",
+    "workflow"
+  ]
+}