create-lore 0.9.0 → 0.11.0

package/.github/CODEOWNERS

@@ -0,0 +1 @@
+* @drewswiredin

package/.github/workflows/release.yml

@@ -6,6 +6,7 @@ on:
 
 permissions:
   contents: write
+  id-token: write
 
 jobs:
   test:
@@ -16,13 +17,13 @@ jobs:
         os: [ubuntu-latest, macos-latest, windows-latest]
         node-version: [18, 20]
     steps:
-      - uses: actions/checkout@v4  # checkout create-lore (this repo)
-      - uses: actions/checkout@v4  # checkout lore template at matching tag
+      - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4  # checkout create-lore (this repo)
+      - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4  # checkout lore template at matching tag
         with:
           repository: lorehq/lore
           ref: ${{ github.ref_name }}
           path: lore
-      - uses: actions/setup-node@v4
+      - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4
         with:
           node-version: ${{ matrix.node-version }}
       - run: npm test
@@ -32,7 +33,7 @@ jobs:
   verify-tag:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
       - name: Verify tag matches package.json version
         run: |
           tag="${GITHUB_REF#refs/tags/v}"
@@ -55,13 +56,13 @@ jobs:
     needs: [test, verify-tag]
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
+      - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
+      - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4
         with:
           node-version: 20
           registry-url: https://registry.npmjs.org
       - name: Publish to npm
-        run: npm publish
+        run: npm publish --provenance
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
       - name: Create GitHub Release

package/.github/workflows/test.yml

@@ -15,14 +15,17 @@ jobs:
         os: [ubuntu-latest, macos-latest, windows-latest]
         node-version: [18, 20]
     steps:
-      - uses: actions/checkout@v4  # checkout create-lore (this repo)
-      - uses: actions/checkout@v4  # checkout lore template (used as LORE_TEMPLATE)
+      - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4  # checkout create-lore (this repo)
+      - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4  # checkout lore template (used as LORE_TEMPLATE)
         with:
           repository: lorehq/lore
           path: lore
-      - uses: actions/setup-node@v4
+      - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4
         with:
           node-version: ${{ matrix.node-version }}
+      - run: npm ci
+      - name: Lint & format
+        run: npx eslint . && npx prettier --check .
       - run: npm test
         env:
           LORE_TEMPLATE: ${{ github.workspace }}/lore
@@ -34,12 +37,12 @@ jobs:
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
+      - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
         with:
           repository: lorehq/lore
           path: lore
-      - uses: actions/setup-node@v4
+      - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4
         with:
           node-version: 20
       - name: Scaffold a project and validate it
@@ -49,4 +52,4 @@ jobs:
         run: |
           node bin/create-lore.js test-project
           cd test-project
-          bash scripts/validate-consistency.sh
+          bash .lore/scripts/validate-consistency.sh

package/.prettierignore

@@ -0,0 +1 @@
+lore/

package/.prettierrc

@@ -0,0 +1,7 @@
+{
+  "singleQuote": true,
+  "semi": true,
+  "trailingComma": "all",
+  "printWidth": 120,
+  "tabWidth": 2
+}

package/README.md

@@ -14,6 +14,7 @@ Lore wraps your coding agent in a git-versioned knowledge base. Hooks fire autom
 - **Knowledge docs** — Environment details, runbooks, architecture decisions. Accumulated across sessions.
 - **Work tracking** — Roadmaps, plans, and brainstorms that persist and appear in every session banner.
 - **Hooks** — Session init, capture reminders, memory protection. All automatic.
+- **Docs UI & Semantic Search** — Run `/lore-docker` to start a local Docker sidecar. Gives agents semantic search over the full knowledge base and opens a live MkDocs site for browsing it visually. Falls back to Grep/Glob without Docker — works for small knowledge bases, degrades as docs grow.
 
 ## Quick Start
 
@@ -27,11 +28,11 @@ Then open the project in your agent. Hooks fire automatically.
 
 ## Supported Platforms
 
-| Platform | Integration |
-|----------|-------------|
-| Claude Code | `hooks/` + `CLAUDE.md` |
-| Cursor | `.cursor/hooks/` + `.cursor/mcp/` + `.cursor/rules/` |
-| OpenCode | `.opencode/plugins/` + `opencode.json` |
+| Platform    | Integration                                                           |
+| ----------- | --------------------------------------------------------------------- |
+| Claude Code | `.lore/hooks/` + `CLAUDE.md`                                          |
+| Cursor      | `.lore/hooks/` + `.cursor/hooks/` + `.cursor/mcp/` + `.cursor/rules/` |
+| OpenCode    | `.opencode/plugins/` + `opencode.json`                                |
 
 All platforms share the same knowledge base. No configuration needed.
 
@@ -48,6 +49,7 @@ npx create-lore --version        # show version
 
 - Node.js 18+
 - git
+- Docker (highly recommended — enables semantic search and docs UI; not required)
 
 ## Docs
 

package/SECURITY.md

@@ -20,5 +20,5 @@ We will acknowledge receipt within 48 hours and provide a timeline for a fix.
 ## Supported Versions
 
 | Version | Supported |
-|---------|-----------|
-| 0.8.x   | Yes       |
+| ------- | --------- |
+| 0.11.x   | Yes       |

package/bin/create-lore.js

@@ -7,7 +7,7 @@
 // How it works:
 //   1. Clones the Lore template from GitHub (or copies from LORE_TEMPLATE env var)
 //   2. Strips the template's .git history
-//   3. Writes a .lore-config with the project name and creation date
+//   3. Writes .lore/config.json with the project name and creation date
 //   4. Runs git init for a clean start
 //
 // The LORE_TEMPLATE env var is used by tests to point at a local template
@@ -99,27 +99,67 @@ try {
     }
   }
   fs.rmSync(path.join(tmpDir, '.git'), { recursive: true, force: true });
+
+  // Only keep files needed in instances — remove everything else
+  const keep = new Set([
+    '.lore',
+    '.claude',
+    '.cursor',
+    '.opencode',
+    'docs',
+    'CLAUDE.md',
+    'opencode.json',
+    '.mcp.json',
+    '.gitattributes',
+    '.gitignore',
+  ]);
+  for (const entry of fs.readdirSync(tmpDir)) {
+    if (!keep.has(entry)) {
+      fs.rmSync(path.join(tmpDir, entry), { recursive: true, force: true });
+    }
+  }
+
   fs.cpSync(tmpDir, targetDir, { recursive: true });
 } finally {
   // Always clean up the temp dir
   if (fs.existsSync(tmpDir)) fs.rmSync(tmpDir, { recursive: true });
 }
 
-// -- Write .lore-config --
+// -- Write .lore/config.json --
 const projectName = isPath ? path.basename(targetDir) : name;
-// Read version from the template's .lore-config so instances track their source version
+// Read version from the copied config.json, then rewrite from template
 let templateConfig;
 try {
-  templateConfig = JSON.parse(fs.readFileSync(path.join(targetDir, '.lore-config'), 'utf8'));
-} catch (e) {
+  templateConfig = JSON.parse(fs.readFileSync(path.join(targetDir, '.lore', 'config.json'), 'utf8'));
+} catch {
   templateConfig = {};
 }
-const config = {
-  name: projectName,
-  version: templateConfig.version || '0.0.0',
-  created: new Date().toISOString().split('T')[0],
-};
-fs.writeFileSync(path.join(targetDir, '.lore-config'), JSON.stringify(config, null, 2) + '\n');
+const templateVersion = templateConfig.version || '0.0.0';
+const createdDate = new Date().toISOString().split('T')[0];
+const configTemplate = fs.readFileSync(path.join(targetDir, '.lore', 'templates', 'config.json'), 'utf8');
+const configContent = configTemplate
+  .replace('{{name}}', projectName)
+  .replace('{{version}}', templateVersion)
+  .replace('{{created}}', createdDate);
+fs.writeFileSync(path.join(targetDir, '.lore', 'config.json'), configContent);
+
+// -- Create gitignored files from templates --
+// Templates are already in targetDir (copied from the template clone via .lore/).
+// These are normally recreated by ensureStickyFiles() each session, but the
+// installer should produce a complete instance from the start.
+const tplDir = path.join(targetDir, '.lore', 'templates');
+const localDir = path.join(targetDir, 'docs', 'knowledge', 'local');
+fs.mkdirSync(localDir, { recursive: true });
+
+fs.writeFileSync(path.join(localDir, 'index.md'), fs.readFileSync(path.join(tplDir, 'local-index.md'), 'utf8'));
+fs.writeFileSync(
+  path.join(localDir, 'operator-profile.md'),
+  fs.readFileSync(path.join(tplDir, 'operator-profile.md'), 'utf8'),
+);
+fs.writeFileSync(
+  path.join(targetDir, '.lore', 'memory.local.md'),
+  fs.readFileSync(path.join(tplDir, 'memory-local.md'), 'utf8'),
+);
 
 // -- Initialize git --
 execSync('git init -b main', { cwd: targetDir, stdio: 'pipe' });

package/eslint.config.js

@@ -0,0 +1,31 @@
+const prettier = require('eslint-config-prettier');
+
+module.exports = [
+  { ignores: ['lore/'] },
+  {
+    files: ['**/*.js'],
+    languageOptions: {
+      ecmaVersion: 2022,
+      sourceType: 'commonjs',
+      globals: {
+        console: 'readonly',
+        process: 'readonly',
+        require: 'readonly',
+        module: 'readonly',
+        __dirname: 'readonly',
+        __filename: 'readonly',
+        exports: 'readonly',
+        Buffer: 'readonly',
+      },
+    },
+    rules: {
+      'no-unused-vars': ['warn', { argsIgnorePattern: '^_' }],
+      'no-undef': 'error',
+      'no-constant-condition': 'warn',
+      eqeqeq: ['error', 'always'],
+      'no-var': 'error',
+      'prefer-const': 'warn',
+    },
+  },
+  prettier,
+];

package/package.json

@@ -1,12 +1,14 @@
 {
   "name": "create-lore",
-  "version": "0.9.0",
+  "version": "0.11.0",
   "description": "Create a new Lore knowledge-persistent agent repo",
   "bin": {
     "create-lore": "bin/create-lore.js"
   },
   "scripts": {
-    "test": "node --test test/create-lore.test.js"
+    "test": "node --test test/create-lore.test.js",
+    "lint": "eslint .",
+    "format:check": "prettier --check ."
   },
   "keywords": [
     "lore",
@@ -15,7 +17,16 @@
     "knowledge"
   ],
   "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/lorehq/create-lore"
+  },
   "engines": {
     "node": ">=18"
+  },
+  "devDependencies": {
+    "eslint": "^9.0.0",
+    "eslint-config-prettier": "^10.1.8",
+    "prettier": "^3.8.1"
   }
 }

package/test/create-lore.test.js

@@ -4,7 +4,7 @@
 
 const { describe, it, before, after } = require('node:test');
 const assert = require('node:assert/strict');
-const { execSync } = require('child_process');
+const { execSync, execFileSync } = require('child_process');
 const fs = require('fs');
 const path = require('path');
 
@@ -14,7 +14,7 @@ const OUTPUT = path.resolve(__dirname, '../test-output');
 
 // Run the installer with LORE_TEMPLATE pointing at the local template
 function run(args = '') {
-  return execSync(`node ${BIN} ${args}`, {
+  return execFileSync('node', [BIN, ...args.split(' ').filter(Boolean)], {
     env: { ...process.env, LORE_TEMPLATE: TEMPLATE },
     stdio: 'pipe',
     encoding: 'utf8',
@@ -23,7 +23,7 @@ function run(args = '') {
 
 // Run with exact argv (no shell interpretation) — for testing shell metacharacters
 function runExact(name) {
-  return require('child_process').execFileSync('node', [BIN, name], {
+  return execFileSync('node', [BIN, name], {
     env: { ...process.env, LORE_TEMPLATE: TEMPLATE },
     stdio: 'pipe',
     encoding: 'utf8',
@@ -59,8 +59,14 @@ describe('create-lore', () => {
 
     assert.ok(fs.existsSync(OUTPUT), 'output directory exists');
 
-    // .lore-config has required fields
-    const config = JSON.parse(fs.readFileSync(path.join(OUTPUT, '.lore-config'), 'utf8'));
+    // .lore/config.json has required fields (JSONC — strip comments before parsing)
+    const raw = fs.readFileSync(path.join(OUTPUT, '.lore', 'config.json'), 'utf8');
+    const config = JSON.parse(
+      raw
+        .replace(/^\s*\/\/.*$/gm, '')
+        .replace(/\/\*[\s\S]*?\*\//g, '')
+        .replace(/,(\s*[}\]])/g, '$1'),
+    );
     assert.ok(config.name, 'name present');
     assert.ok(config.created, 'created date present');
 
@@ -70,6 +76,34 @@ describe('create-lore', () => {
     assert.ok(entries.includes('HEAD'), '.git looks like a fresh init');
   });
 
+  it('strips dev-only files from scaffolded instance', () => {
+    cleanup();
+    run(OUTPUT);
+
+    const devOnly = [
+      'test',
+      '.github',
+      'node_modules',
+      'site',
+      'docs/assets',
+      'docs/javascripts',
+      'docs/stylesheets',
+      'CODE_OF_CONDUCT.md',
+      'CONTRIBUTING.md',
+      'SECURITY.md',
+      'LICENSE',
+      'README.md',
+      '.prettierrc',
+      '.prettierignore',
+      'eslint.config.js',
+      'package-lock.json',
+    ];
+    for (const name of devOnly) {
+      assert.ok(!fs.existsSync(path.join(OUTPUT, name)), `${name} should be stripped`);
+    }
+    cleanup();
+  });
+
   it('fails if target directory already exists', () => {
     fs.mkdirSync(OUTPUT, { recursive: true });
     assert.throws(() => run(OUTPUT), /already exists/);
@@ -113,14 +147,16 @@ describe('create-lore', () => {
     if (!fs.existsSync(path.join(TEMPLATE, '.opencode/plugins'))) return;
 
     run(OUTPUT);
-    assert.ok(fs.existsSync(path.join(OUTPUT, '.opencode', 'plugins', 'session-init.js')),
-      'session-init.js copied');
-    assert.ok(fs.existsSync(path.join(OUTPUT, '.opencode', 'plugins', 'knowledge-tracker.js')),
-      'knowledge-tracker.js copied');
-    assert.ok(fs.existsSync(path.join(OUTPUT, '.opencode', 'plugins', 'protect-memory.js')),
-      'protect-memory.js copied');
-    assert.ok(fs.existsSync(path.join(OUTPUT, '.opencode', 'package.json')),
-      '.opencode/package.json copied');
+    assert.ok(fs.existsSync(path.join(OUTPUT, '.opencode', 'plugins', 'session-init.js')), 'session-init.js copied');
+    assert.ok(
+      fs.existsSync(path.join(OUTPUT, '.opencode', 'plugins', 'knowledge-tracker.js')),
+      'knowledge-tracker.js copied',
+    );
+    assert.ok(
+      fs.existsSync(path.join(OUTPUT, '.opencode', 'plugins', 'protect-memory.js')),
+      'protect-memory.js copied',
+    );
+    assert.ok(fs.existsSync(path.join(OUTPUT, '.opencode', 'package.json')), '.opencode/package.json copied');
     cleanup();
   });
 
@@ -135,10 +171,10 @@ describe('create-lore', () => {
   });
 
   it('passes validate-consistency.sh when template provides it', () => {
-    if (!fs.existsSync(path.join(TEMPLATE, 'scripts/validate-consistency.sh'))) return;
+    if (!fs.existsSync(path.join(TEMPLATE, '.lore/scripts/validate-consistency.sh'))) return;
 
     run(OUTPUT);
-    const result = execSync('bash scripts/validate-consistency.sh', {
+    const result = execSync('bash .lore/scripts/validate-consistency.sh', {
       cwd: OUTPUT,
       encoding: 'utf8',
       stdio: 'pipe',