@vertesia/memory-cli 0.24.0-dev.202601221707

package/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2024 Composable
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,112 @@
+# @vertesia/memory-cli
+
+A command-line tool for building and managing Vertesia memory packs. Memory packs are archives containing structured data for LLM context.
+
+## Features
+
+- **Build Memory Packs**: Create memory archives from recipe scripts
+- **Export Data**: Extract JSON objects from memory packs using mappings
+- **Gzip Compression**: Optionally compress output files
+- **Custom Variables**: Pass variables to recipe scripts via command line
+
+## Requirements
+
+Node.js version 18 or higher is required.
+
+## Installation
+
+```bash
+npm install -g @vertesia/memory-cli
+# or
+pnpm add -g @vertesia/memory-cli
+```
+
+## Usage
+
+### Build a Memory Pack
+
+Build a memory pack from a recipe script:
+
+```bash
+memo build <recipe>
+```
+
+#### Options
+
+| Option | Description |
+|--------|-------------|
+| `-o, --out <file>` | Output file (default: `memory.tar`) |
+| `-z, --gzip` | Compress output with gzip |
+| `-i, --indent <spaces>` | JSON indentation (default: 2) |
+| `-q, --quiet` | Suppress console output |
+| `-t, --test` | Test recipe without building |
+
+#### Passing Variables
+
+Pass custom variables to your recipe script using `--var-<name>`:
+
+```bash
+memo build recipe.ts --var-version 1.0.0 --var-env production
+```
+
+Variables are available in your recipe script via the `vars` object.
+
+### Export from Memory Pack
+
+Export a JSON object from a memory pack using a mapping:
+
+```bash
+memo export <pack> --map <mapping>
+```
+
+#### Examples
+
+```bash
+# Export with inline JSON mapping
+memo export memory.tar --map '{"title": "$.metadata.title", "content": "$.files[0].content"}'
+
+# Export with mapping file
+memo export memory.tar --map @mapping.json
+
+# Export with custom indentation
+memo export memory.tar --map @mapping.json --indent 4
+```
+
+## Recipe Scripts
+
+Recipe scripts are TypeScript files that define how to build a memory pack. They use the `@vertesia/memory` API to collect and structure data.
+
+Example recipe (`recipe.ts`):
+
+```typescript
+import { MemoryBuilder } from '@vertesia/memory';
+
+const builder = new MemoryBuilder();
+
+// Add files, metadata, and structured data
+builder.addFile('README.md', readFileSync('README.md'));
+builder.setMetadata({ version: vars.version });
+
+export default builder;
+```
+
+## API
+
+The CLI can also be used programmatically:
+
+```typescript
+import { setupMemoCommand } from '@vertesia/memory-cli';
+import { Command } from 'commander';
+
+const program = new Command();
+setupMemoCommand(program);
+program.parse();
+```
+
+## Documentation
+
+See [Vertesia Documentation](https://docs.vertesiahq.com)
+
+## License
+
+Apache-2.0

package/bin/memo.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+import '../lib/cli.js'

package/lib/cli.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=cli.d.ts.map

package/lib/cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":""}

package/lib/cli.js

@@ -0,0 +1,20 @@
+import { program } from 'commander';
+import { setupMemoCommand } from './command.js';
+import { dirname } from 'path';
+import { fileURLToPath } from 'url';
+import { readFileSync } from 'fs';
+const packageDir = dirname(dirname(fileURLToPath(import.meta.url)));
+let _package;
+function getPackage() {
+    if (_package === undefined) {
+        _package = JSON.parse(readFileSync(`${packageDir}/package.json`, 'utf8'));
+    }
+    return _package;
+}
+function getVersion() {
+    return getPackage().version;
+}
+program.version(getVersion());
+setupMemoCommand(program);
+program.parse();
+//# sourceMappingURL=cli.js.map

package/lib/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAChD,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAC/B,OAAO,EAAE,aAAa,EAAE,MAAM,KAAK,CAAC;AACpC,OAAO,EAAE,YAAY,EAAE,MAAM,IAAI,CAAC;AAElC,MAAM,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;AAEpE,IAAI,QAAa,CAAC;AAClB,SAAS,UAAU;IACf,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QACzB,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,GAAG,UAAU,eAAe,EAAE,MAAM,CAAC,CAAC,CAAC;IAC9E,CAAC;IACD,OAAO,QAAQ,CAAC;AACpB,CAAC;AACD,SAAS,UAAU;IACf,OAAO,UAAU,EAAE,CAAC,OAAO,CAAC;AAChC,CAAC;AAED,OAAO,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC;AAC9B,gBAAgB,CAAC,OAAO,CAAC,CAAC;AAC1B,OAAO,CAAC,KAAK,EAAE,CAAC"}

package/lib/command.d.ts

@@ -0,0 +1,3 @@
+import { Command } from 'commander';
+export declare function setupMemoCommand(command: Command, publish?: (file: string, name: string) => Promise<string>): Command;
+//# sourceMappingURL=command.d.ts.map

package/lib/command.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"command.d.ts","sourceRoot":"","sources":["../src/command.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAKpC,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,WA8B3G"}

package/lib/command.js

@@ -0,0 +1,101 @@
+import { loadMemoryPack } from '@vertesia/memory';
+import { build } from '@vertesia/memory-commands';
+import { Command } from 'commander';
+import { readFile } from 'fs/promises';
+import { dirname } from 'path';
+import url from 'url';
+export function setupMemoCommand(command, publish) {
+    const buildCmd = new Command("build").description("Build a memory pack from a recipe script.");
+    buildCmd.allowUnknownOption()
+        .option('-i, --indent <spaces>', 'The number of spaces to indent the JSON result. A indentation of 2 is used by default.')
+        .option('-q, --quiet', 'Do not log anything to the console.')
+        .option('-z, --gzip', 'Compress the output file using gzip.')
+        .option('-o, --out <file>', 'The output file. Defaults to "memory.tar".')
+        .option('-t, --test', 'Test the memory script without building it.')
+        .argument('<recipe>', 'The recipe script to build the memory from.')
+        .action((_arg, options, command) => {
+        memoAction(command, { ...options, publish }).catch((err) => {
+            console.error("Failed to run command: ", err);
+            process.exit(1);
+        });
+    });
+    const exportCmd = new Command("export").description("Export a JSON object from the memory pack given a mapping.");
+    exportCmd.option('--map <mapping>', 'The mapping to use. An inline JSON object or a path to a JSOn file prefixed with @')
+        .option('-i, --indent <spaces>', 'The number of spaces to indent the JSON result. No indentation is done by default.')
+        .argument('<pack>', 'The uncompressed memory pack to use (i.e. a .tar file).')
+        .action((arg, options, command) => {
+        exportAction(command, arg, options).catch((err) => {
+            console.error("Failed to run command: ", err);
+            process.exit(1);
+        });
+    });
+    command.addCommand(buildCmd);
+    command.addCommand(exportCmd);
+    return command;
+}
+function memoAction(command, options) {
+    const { script, vars } = parseArgs(command.args);
+    if (options.indent) {
+        options.indent = parseInt(options.indent);
+    }
+    if (!options.transpileDir) {
+        options.transpileDir = dirname(url.fileURLToPath(import.meta.url));
+    }
+    return build(script, { ...options, vars });
+}
+/**
+ * We take all --var-xxx options and return them as an object to be passed as the `vars` variable to the script
+ * @param args
+ */
+function parseArgs(args) {
+    if (!args.length) {
+        console.error("No recipe script was provided.");
+        process.exit(1);
+    }
+    let script;
+    const vars = {};
+    let lastKey;
+    let lastCommittedOption;
+    for (const arg of args) {
+        if (arg.startsWith('--var-')) {
+            if (lastKey) {
+                vars[lastKey] = true;
+            }
+            lastKey = arg.substring(6);
+        }
+        else if (lastKey) {
+            vars[lastKey] = arg;
+            lastCommittedOption = lastKey;
+            lastKey = undefined;
+        }
+        else if (script) {
+            console.error(`Ambiguous command line arguments. Multiple recipe scripts found: ${script}, ${arg}`);
+            process.exit(1);
+        }
+        else {
+            script = arg;
+        }
+    }
+    if (!script) {
+        if (!lastCommittedOption) {
+            console.error("Ambiguous command line arguments. No recipe script was found.");
+            process.exit(1);
+        }
+        else {
+            script = vars[lastCommittedOption];
+            vars[lastCommittedOption] = true;
+        }
+    }
+    return { script, vars };
+}
+async function exportAction(_command, packFile, options) {
+    let mapParam = options.map;
+    if (mapParam.startsWith('@')) {
+        mapParam = await readFile(mapParam.substring(1), "utf-8");
+    }
+    const mapping = JSON.parse(mapParam);
+    const pack = await loadMemoryPack(packFile);
+    const obj = await pack.exportObject(mapping);
+    console.log(JSON.stringify(obj, null, options.indent || 2));
+}
+//# sourceMappingURL=command.js.map

package/lib/command.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"command.js","sourceRoot":"","sources":["../src/command.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAChE,OAAO,EAAE,KAAK,EAAE,MAAM,2BAA2B,CAAC;AAClD,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAC/B,OAAO,GAAG,MAAM,KAAK,CAAC;AAEtB,MAAM,UAAU,gBAAgB,CAAC,OAAgB,EAAE,OAAyD;IACxG,MAAM,QAAQ,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC,WAAW,CAAC,2CAA2C,CAAC,CAAC;IAC/F,QAAQ,CAAC,kBAAkB,EAAE;SACxB,MAAM,CAAC,uBAAuB,EAAE,wFAAwF,CAAC;SACzH,MAAM,CAAC,aAAa,EAAE,qCAAqC,CAAC;SAC5D,MAAM,CAAC,YAAY,EAAE,sCAAsC,CAAC;SAC5D,MAAM,CAAC,kBAAkB,EAAE,4CAA4C,CAAC;SACxE,MAAM,CAAC,YAAY,EAAE,6CAA6C,CAAC;SACnE,QAAQ,CAAC,UAAU,EAAE,6CAA6C,CAAC;SACnE,MAAM,CAAC,CAAC,IAAY,EAAE,OAA4B,EAAE,OAAgB,EAAE,EAAE;QACrE,UAAU,CAAC,OAAO,EAAE,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,GAAU,EAAE,EAAE;YAC9D,OAAO,CAAC,KAAK,CAAC,yBAAyB,EAAE,GAAG,CAAC,CAAC;YAC9C,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACpB,CAAC,CAAC,CAAA;IACN,CAAC,CAAC,CAAA;IAEN,MAAM,SAAS,GAAG,IAAI,OAAO,CAAC,QAAQ,CAAC,CAAC,WAAW,CAAC,4DAA4D,CAAC,CAAC;IAClH,SAAS,CAAC,MAAM,CAAC,iBAAiB,EAAE,oFAAoF,CAAC;SACpH,MAAM,CAAC,uBAAuB,EAAE,oFAAoF,CAAC;SACrH,QAAQ,CAAC,QAAQ,EAAE,yDAAyD,CAAC;SAC7E,MAAM,CAAC,CAAC,GAAW,EAAE,OAA4B,EAAE,OAAgB,EAAE,EAAE;QACpE,YAAY,CAAC,OAAO,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,GAAU,EAAE,EAAE;YACrD,OAAO,CAAC,KAAK,CAAC,yBAAyB,EAAE,GAAG,CAAC,CAAC;YAC9C,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACpB,CAAC,CAAC,CAAA;IACN,CAAC,CAAC,CAAC;IAEP,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IAC7B,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IAC9B,OAAO,OAAO,CAAC;AACnB,CAAC;AAED,SAAS,UAAU,CAAC,OAAgB,EAAE,OAA4B;IAC9D,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACjD,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;QACjB,OAAO,CAAC,MAAM,GAAG,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC9C,CAAC;IACD,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC;QACxB,OAAO,CAAC,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IACvE,CAAC;IACD,OAAO,KAAK,CAAC,MAAO,EAAE,EAAE,GAAG,OAAO,EAAE,IAAI,EAAkB,CAAC,CAAA;AAC/D,CAAC;AAED;;;GAGG;AACH,SAAS,SAAS,CAAC,IAAc;IAC7B,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,gCAAgC,CAAC,CAAC;QAChD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACpB,CAAC;IACD,IAAI,MAA0B,CAAC;IAC/B,MAAM,IAAI,GAAwB,EAAE,CAAC;IACrC,IAAI,OAA2B,CAAC;IAChC,IAAI,mBAAuC,CAAC;IAC5C,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACrB,IAAI,GAAG,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC3B,IAAI,OAAO,EAAE,CAAC;gBACV,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;YACzB,CAAC;YACD,OAAO,GAAG,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QAC/B,CAAC;aAAM,IAAI,OAAO,EAAE,CAAC;YACjB,IAAI,CAAC,OAAO,CAAC,GAAG,GAAG,CAAC;YACpB,mBAAmB,GAAG,OAAO,CAAC;YAC9B,OAAO,GAAG,SAAS,CAAC;QACxB,CAAC;aAAM,IAAI,MAAM,EAAE,CAAC;YAChB,OAAO,CAAC,KAAK,CAAC,oEAAoE,MAAM,KAAK,GAAG,EAAE,CAAC,CAAC;YACpG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACpB,CAAC;aAAM,CAAC;YACJ,MAAM,GAAG,GAAG,CAAC;QACjB,CAAC;IACL,CAAC;IACD,IAAI,CAAC,MAAM,EAAE,CAAC;QACV,IAAI,CAAC,mBAAmB,EAAE,CAAC;YACvB,OAAO,CAAC,KAAK,CAAC,+DAA+D,CAAC,CAAC;YAC/E,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACpB,CAAC;aAAM,CAAC;YACJ,MAAM,GAAG,IAAI,CAAC,mBAAmB,CAAC,CAAC;YACnC,IAAI,CAAC,mBAAmB,CAAC,GAAG,IAAI,CAAC;QACrC,CAAC;IACL,CAAC;IACD,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;AAC5B,CAAC;AAED,KAAK,UAAU,YAAY,CAAC,QAAiB,EAAE,QAAgB,EAAE,OAA4B;IACzF,IAAI,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC;IAC3B,IAAI,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QAC3B,QAAQ,GAAG,MAAM,QAAQ,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;IACD,MAAM,OAAO,GAAwB,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAC1D,MAAM,IAAI,GAAG,MAAM,cAAc,CAAC,QAAQ,CAAC,CAAC;IAC5C,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IAC7C,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,EAAE,OAAO,CAAC,MAAM,IAAI,CAAC,CAAC,CAAC,CAAC;AAChE,CAAC"}

package/lib/index.d.ts

@@ -0,0 +1,3 @@
+import { setupMemoCommand } from './command.js';
+export { setupMemoCommand };
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAEhD,OAAO,EAAE,gBAAgB,EAAE,CAAC"}

package/lib/index.js

@@ -0,0 +1,3 @@
+import { setupMemoCommand } from './command.js';
+export { setupMemoCommand };
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAEhD,OAAO,EAAE,gBAAgB,EAAE,CAAC"}

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@vertesia/memory-cli",
+  "description": "Vertesia memory builder CLI",
+  "version": "0.24.0-dev.202601221707",
+  "type": "module",
+  "bin": {
+    "memo": "./bin/memo.js"
+  },
+  "main": "./lib/index.js",
+  "types": "./lib/index.d.ts",
+  "files": [
+    "lib",
+    "bin"
+  ],
+  "license": "Apache-2.0",
+  "homepage": "https://docs.vertesiahq.com",
+  "keywords": [
+    "vertesia",
+    "memory",
+    "cli",
+    "llm",
+    "ai",
+    "context",
+    "typescript"
+  ],
+  "dependencies": {
+    "commander": "^14.0.2",
+    "@vertesia/memory": "0.24.0-dev.202601221707",
+    "@vertesia/memory-commands": "0.24.0-dev.202601221707"
+  },
+  "devDependencies": {
+    "@types/node": "^22.19.2",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.16"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/vertesia/composableai.git",
+    "directory": "packages/memory-cli"
+  },
+  "scripts": {
+    "eslint": "eslint './src/**/*.{jsx,js,tsx,ts}'",
+    "build": "rm -rf ./lib ./tsconfig.tsbuildinfo && tsc --build",
+    "clean": "rimraf ./node_modules ./lib ./tsconfig.tsbuildinfo"
+  }
+}