@fugui200/llmwiki 0.1.2-beta.0

package/README.md

@@ -0,0 +1,60 @@
+# llmwiki
+
+CLI for connecting AI coding agents to a project-scoped markdown knowledge base.
+
+`llmwiki` does not upload or index your files. It writes local project markers and
+agent context so Codex CLI, Claude Code, and Gemini CLI can decide when to recall
+or archive wiki knowledge.
+
+## Install
+
+```bash
+npm install -g @fugui200/llmwiki@beta
+```
+
+## Usage
+
+Initialize the current project:
+
+```bash
+llmwiki init
+```
+
+Non-interactive examples:
+
+```bash
+llmwiki init --profile personal --agent codex
+llmwiki init --profile local --agent claude-code
+llmwiki init --workspace --profile team --wiki-root /path/to/team-wiki --agent all
+```
+
+Check the current project routing:
+
+```bash
+llmwiki status
+llmwiki classify
+llmwiki classify path/to/file path/to/another-file
+```
+
+Sync a git-backed wiki root:
+
+```bash
+llmwiki pull
+llmwiki push "archive: update project notes"
+```
+
+## Profiles
+
+- `personal`: defaults to `~/.llmwiki`.
+- `team`: requires an explicit `--wiki-root`.
+- `local`: defaults to `.llmwiki-local` and disables `push`/`pull`.
+
+## Agents
+
+- `codex`: writes `.llmwiki.json` and installs a global Codex hook.
+- `claude-code`: writes `.claude/settings.json` plus a lightweight `CLAUDE.md` block.
+- `gemini`: writes a lightweight `GEMINI.md` block.
+- `all`: configures all supported agents.
+
+Agent integrations only inject routing metadata and recall rules. They do not
+load the whole wiki on every prompt.

package/bin/llmwiki.js

@@ -0,0 +1,251 @@
+#!/usr/bin/env node
+'use strict';
+
+const fs = require('fs');
+const path = require('path');
+const { execFileSync, execSync } = require('child_process');
+
+const HOME = require('os').homedir();
+const LLMWIKI_DIR = process.env.LLMWIKI_DIR
+  ? path.resolve(process.env.LLMWIKI_DIR)
+  : path.join(HOME, '.llmwiki');
+const PACKAGE_ROOT = path.resolve(__dirname, '..');
+const PKG_JSON = path.resolve(__dirname, '..', 'package.json');
+
+function resolveRuntimeRoot() {
+  if (fs.existsSync(path.join(PACKAGE_ROOT, 'scripts', 'init-project.js'))) return PACKAGE_ROOT;
+  if (fs.existsSync(path.join(LLMWIKI_DIR, 'scripts', 'init-project.js'))) return LLMWIKI_DIR;
+  return LLMWIKI_DIR;
+}
+
+const RUNTIME_ROOT = resolveRuntimeRoot();
+
+async function main() {
+  const args = process.argv.slice(2);
+
+  if (args[0] === '--version' || args[0] === '-v') {
+    const pkg = JSON.parse(fs.readFileSync(PKG_JSON, 'utf8'));
+    console.log(pkg.version);
+  } else if (!args[0] || args[0] === 'help' || args[0] === '--help' || args[0] === '-h') {
+    showHelp();
+  } else if (args[0] === 'init') {
+    if (isHelpArg(args[1])) {
+      showInitHelp();
+    } else {
+      await initProject();
+    }
+  } else if (args[0] === 'classify') {
+    classifyProject(args.slice(1));
+  } else if (args[0] === 'status') {
+    showStatus();
+  } else if (args[0] === 'push') {
+    pushWiki(args.slice(1).join(' '));
+  } else if (args[0] === 'pull') {
+    pullWiki();
+  } else {
+    showHelp();
+  }
+}
+
+function isHelpArg(arg) {
+  return arg === 'help' || arg === '--help' || arg === '-h';
+}
+
+function showHelp() {
+  console.log('用法: llmwiki <command>');
+  console.log('');
+  console.log('命令:');
+  console.log('  init [options]      交互式导入 Agent、workspace/profile/wikiRoot 配置');
+  console.log('  classify [paths...] 根据 .llmwiki.json 判断归档项目归属');
+  console.log('  status              显示当前项目的 wiki 同步边界');
+  console.log('  push [msg]          提交并推送当前 wikiRoot 的变更');
+  console.log('  pull                拉取当前 wikiRoot 的最新内容');
+  console.log('  help                显示帮助信息');
+  console.log('');
+  console.log('Profile:');
+  console.log('  personal            个人知识库，默认 wikiRoot=~/.llmwiki');
+  console.log('  team                公司或团队共享知识库，必须显式指定 --wiki-root');
+  console.log('  local               仅本地沉淀，不允许 push/pull');
+  console.log('');
+  console.log('选项:');
+  console.log('  --version, -v 显示版本号');
+}
+
+function showInitHelp() {
+  console.log('用法: llmwiki init [--workspace] [--profile personal|team|local] [--wiki-root <path>] [--agent <agent>]');
+  console.log('');
+  console.log('说明:');
+  console.log('  为当前项目导入指定 Agent 的 LLM Wiki 接入配置。');
+  console.log('');
+  console.log('Agent:');
+  console.log('  claude-code  写入 .claude/settings.json hooks');
+  console.log('  codex        写入 .llmwiki.json 项目标记，并安装全局 Codex hooks');
+  console.log('  gemini       写入 GEMINI.md 项目上下文入口');
+  console.log('  all          同时导入 claude-code、codex、gemini');
+  console.log('');
+  console.log('选项:');
+  console.log('  --workspace  生成 workspace 配置 .llmwiki.json，用于多子项目归属判断');
+  console.log('  --profile    设置知识库同步边界: personal | team | local');
+  console.log('  --wiki-root  设置当前项目使用的物理 wiki 根目录');
+  console.log('  --branch     设置 git 同步分支，默认 main');
+  console.log('  --help, -h   显示 init 帮助信息');
+}
+
+function loadClassifier() {
+  const classifier = path.join(RUNTIME_ROOT, 'scripts', 'classify-project.js');
+  if (!fs.existsSync(classifier)) {
+    console.error('错误: classify-project.js 不存在');
+    console.error(`期望路径: ${classifier}`);
+    process.exit(1);
+  }
+  return require(classifier);
+}
+
+function classifyProject(paths) {
+  const { classifyFromCwd } = loadClassifier();
+  const result = classifyFromCwd({ paths });
+  console.log(JSON.stringify(result, null, 2));
+}
+
+function defaultWikiContext(cwd = process.cwd()) {
+  const config = {
+    type: 'project',
+    name: 'default',
+    profile: 'personal',
+    wikiRoot: '~/.llmwiki',
+    sync: {
+      type: 'git',
+      branch: 'main',
+    },
+  };
+  return {
+    cwd,
+    config,
+    configDir: cwd,
+    configPath: null,
+    classification: {
+      workspace: null,
+      matchedProjects: [],
+      archiveProjects: [],
+      archiveType: 'unconfigured',
+      suggestedPath: null,
+    },
+    wikiRoot: LLMWIKI_DIR,
+  };
+}
+
+function getWikiContext(cwd = process.cwd()) {
+  const {
+    classifyConfig,
+    findEffectiveConfig,
+    resolveWikiRoot,
+  } = loadClassifier();
+  const match = findEffectiveConfig(cwd);
+  if (!match) return defaultWikiContext(cwd);
+
+  return {
+    cwd,
+    config: match.config,
+    configDir: match.dir,
+    configPath: match.path,
+    classification: classifyConfig(match.config, match.dir, { cwd }),
+    wikiRoot: resolveWikiRoot(match.config, match.dir),
+  };
+}
+
+function formatSync(sync = {}) {
+  if (sync.type === 'none') return 'none';
+  return `${sync.type || 'git'} ${sync.branch || 'main'}`;
+}
+
+function showStatus() {
+  const context = getWikiContext();
+  const { config, classification } = context;
+  const project = (classification.archiveProjects || [])[0] || config.name || '(none)';
+  console.log(`project: ${project}`);
+  console.log(`profile: ${config.profile || 'personal'}`);
+  console.log(`wikiRoot: ${context.wikiRoot}`);
+  console.log(`sync: ${formatSync(config.sync)}`);
+  console.log(`archiveTarget: ${classification.suggestedPath || '(none)'}`);
+}
+
+function ensureGitSync(context) {
+  const sync = context.config.sync || { type: 'git', branch: 'main' };
+  if (sync.type === 'none') {
+    console.error('错误: 当前 wiki 实例未启用 git 同步');
+    console.error(`wikiRoot: ${context.wikiRoot}`);
+    console.error(`profile: ${context.config.profile || 'personal'}`);
+    process.exit(1);
+  }
+  return {
+    type: sync.type || 'git',
+    branch: sync.branch || 'main',
+  };
+}
+
+function pullWiki() {
+  const context = getWikiContext();
+  const sync = ensureGitSync(context);
+  if (!fs.existsSync(path.join(context.wikiRoot, '.git'))) {
+    console.error(`错误: ${context.wikiRoot} 不是 git 仓库`);
+    process.exit(1);
+  }
+  console.log(`wikiRoot: ${context.wikiRoot}`);
+  console.log(`profile: ${context.config.profile || 'personal'}`);
+  console.log(`sync: ${formatSync(sync)}`);
+  execFileSync('git', ['pull', '--rebase', 'origin', sync.branch], { cwd: context.wikiRoot, stdio: 'inherit' });
+}
+
+function pushWiki(msg) {
+  const context = getWikiContext();
+  const sync = ensureGitSync(context);
+  if (!fs.existsSync(path.join(context.wikiRoot, '.git'))) {
+    console.error(`错误: ${context.wikiRoot} 不是 git 仓库`);
+    process.exit(1);
+  }
+
+  const status = execSync('git status --porcelain', { cwd: context.wikiRoot, encoding: 'utf8' });
+  if (!status.trim()) {
+    console.log('没有需要提交的变更。');
+    return;
+  }
+
+  const commitMsg = msg || '[archive] wiki update';
+  console.log(`wikiRoot: ${context.wikiRoot}`);
+  console.log(`profile: ${context.config.profile || 'personal'}`);
+  console.log(`sync: ${formatSync(sync)}`);
+  console.log(`变更文件:\n${status}`);
+  console.log(`提交信息: ${commitMsg}`);
+
+  execFileSync('git', ['add', '-A'], { cwd: context.wikiRoot, stdio: 'inherit' });
+  execFileSync('git', ['commit', '-m', commitMsg], { cwd: context.wikiRoot, stdio: 'inherit' });
+  execFileSync('git', ['push', 'origin', sync.branch], { cwd: context.wikiRoot, stdio: 'inherit' });
+
+  console.log('推送完成。');
+}
+
+async function initProject() {
+  if (!fs.existsSync(RUNTIME_ROOT)) {
+    console.error('错误: ~/.llmwiki 不存在');
+    console.error('');
+    console.error('解决方法：');
+    console.error('  npm install -g llmwiki@beta');
+    console.error('  或设置 LLMWIKI_DIR=/path/to/llmwiki-runtime');
+    process.exit(1);
+  }
+
+  const initScript = path.join(RUNTIME_ROOT, 'scripts', 'init-project.js');
+  if (fs.existsSync(initScript)) {
+    const init = require(initScript);
+    await init.main();
+  } else {
+    console.error('错误: init-project.js 不存在');
+    console.error(`期望路径: ${initScript}`);
+    process.exit(1);
+  }
+}
+
+main().catch(error => {
+  console.error(error.message);
+  process.exit(1);
+});

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@fugui200/llmwiki",
+  "version": "0.1.2-beta.0",
+  "description": "Project-scoped LLM wiki CLI for Codex, Claude Code, and Gemini",
+  "bin": {
+    "llmwiki": "bin/llmwiki.js"
+  },
+  "scripts": {
+    "test": "node --test test/*.test.js",
+    "wiki:lint": "node scripts/wiki-lint.js",
+    "wiki:overview": "node scripts/wiki-build-overview.js",
+    "wiki:graph": "node scripts/wiki-build-graph.js"
+  },
+  "files": [
+    "bin/llmwiki.js",
+    "scripts/classify-project.js",
+    "scripts/codex-hook.js",
+    "scripts/init-project.js",
+    "skill/llmwiki-connector/"
+  ],
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "license": "MIT",
+  "private": false,
+  "type": "commonjs"
+}