Self-evolving Context Database for AI Agents. Unify Agent Memory, Knowledge RAG and Skills.
Python agent-contextagent-memoryagent-pluginsagentic-ragcontext-databasedsh-pluginknowledge-basememorymemory-managementself-evolvingvector-database
feat(cli): publish native CLI to npm on tag push (#1944)
Zayn Jarvis43086161d2f6
diff --git a/.github/workflows/rust-cli.yml b/.github/workflows/rust-cli.ymlindex 37bd2ab2c..5dca2a9cf 100644--- a/.github/workflows/rust-cli.yml+++ b/.github/workflows/rust-cli.yml@@ -9,7 +9,7 @@ on:- 'Cargo.toml'- '.github/workflows/rust-cli.yml'tags:- - 'cli@*' # Trigger release on tags starting with cli@+ - 'cli@*'pull_request:branches: [ main ]paths:@@ -28,18 +28,33 @@ jobs:- os: ubuntu-24.04target: x86_64-unknown-linux-gnuartifact_name: ov-linux-x86_64+ npm_pkg: cli-linux-x64+ npm_os: linux+ npm_cpu: x64- os: ubuntu-24.04target: aarch64-unknown-linux-gnuartifact_name: ov-linux-aarch64+ npm_pkg: cli-linux-arm64+ npm_os: linux+ npm_cpu: arm64- os: macos-15-inteltarget: x86_64-apple-darwinartifact_name: ov-macos-x86_64+ npm_pkg: cli-darwin-x64+ npm_os: darwin+ npm_cpu: x64- os: macos-14target: aarch64-apple-darwinartifact_name: ov-macos-aarch64+ npm_pkg: cli-darwin-arm64+ npm_os: darwin+ npm_cpu: arm64- os: windows-latesttarget: x86_64-pc-windows-msvcartifact_name: ov-windows-x86_64.exe+ npm_pkg: cli-win32-x64+ npm_os: win32+ npm_cpu: x64steps:- uses: actions/checkout@v6@@ -85,65 +100,79 @@ jobs:${{ runner.os }}-target-${{ matrix.target }}-${{ hashFiles('**/Cargo.lock') }}-${{ runner.os }}-target-${{ matrix.target }}-- - name: Build CLI- run: cargo build --release --target ${{ matrix.target }} -p ov_cli-- - name: Create compressed artifacts+ - name: Inject version from tagshell: bashrun: |- mkdir -p artifacts- cd target/${{ matrix.target }}/release-- if [[ "${{ matrix.os }}" == "windows-latest" ]]; then- # Windows: create zip- 7z a ../../../artifacts/${{ matrix.artifact_name }}.zip ov.exe- cd ../../../artifacts- # Use PowerShell to get hash in correct format- powershell -Command "(Get-FileHash -Algorithm SHA256 '${{ matrix.artifact_name }}.zip').Hash.ToLower() + ' ${{ matrix.artifact_name }}.zip'" > ${{ matrix.artifact_name }}.zip.sha256- else- # Unix: create tar.gz- tar czf ../../../artifacts/${{ matrix.artifact_name }}.tar.gz ov- cd ../../../artifacts- # shasum format: <hash> <filename>- shasum -a 256 ${{ matrix.artifact_name }}.tar.gz > ${{ matrix.artifact_name }}.tar.gz.sha256+ VERSION="${GITHUB_REF#refs/tags/cli@}"+ if [[ "$VERSION" != "$GITHUB_REF" ]]; then+ sed -i.bak "s/^version = \"0.0.0\"/version = \"$VERSION\"/" crates/ov_cli/Cargo.toml+ rm -f crates/ov_cli/Cargo.toml.bak+ echo "Injected version $VERSION into Cargo.toml"fi- - name: Verify checksum format+ - name: Build CLI+ run: cargo build --release --target ${{ matrix.target }} -p ov_cli++ - name: Package platform npm packageshell: bashrun: |- echo "Contents of checksum file:"- cat artifacts/*.sha256- echo ""- echo "Verifying checksum locally:"- cd artifacts+ VERSION="${GITHUB_REF#refs/tags/cli@}"+ # For non-tag builds, use 0.0.0-dev+ if [[ "$VERSION" == "$GITHUB_REF" ]]; then+ VERSION="0.0.0-dev"+ fi++ PKG_DIR="npm-pkg"+ mkdir -p "$PKG_DIR/bin"+if [[ "${{ matrix.os }}" == "windows-latest" ]]; then- sha256sum -c *.sha256 || shasum -a 256 -c *.sha256 || echo "Checksum verification skipped on Windows"+ cp "target/${{ matrix.target }}/release/ov.exe" "$PKG_DIR/bin/ov.exe"else- shasum -a 256 -c *.sha256+ cp "target/${{ matrix.target }}/release/ov" "$PKG_DIR/bin/ov"+ chmod +x "$PKG_DIR/bin/ov"fi- - name: Upload artifacts+ node -e "+ const pkg = {+ name: '@openviking/${{ matrix.npm_pkg }}',+ version: '$VERSION',+ description: 'OpenViking CLI native binary for ${{ matrix.npm_os }}-${{ matrix.npm_cpu }}',+ os: ['${{ matrix.npm_os }}'],+ cpu: ['${{ matrix.npm_cpu }}'],+ files: ['bin'],+ license: 'Apache-2.0',+ repository: { type: 'git', url: 'git+https://github.com/volcengine/openviking.git' },+ publishConfig: { access: 'public' }+ };+ require('fs').writeFileSync('$PKG_DIR/package.json', JSON.stringify(pkg, null, 2) + '\n');+ "++ - name: Upload npm package artifactuses: actions/upload-artifact@v7with:- name: ${{ matrix.artifact_name }}- path: artifacts/*+ name: ${{ matrix.npm_pkg }}+ path: npm-pkg/- release:- name: Create GitHub Release+ npm-publish:+ name: Publish to npmruns-on: ubuntu-24.04needs: buildif: startsWith(github.ref, 'refs/tags/cli@')- permissions:- contents: writesteps:- name: Checkout codeuses: actions/checkout@v6+ - name: Setup Node.js+ uses: actions/setup-node@v4+ with:+ node-version: '22'+ registry-url: 'https://registry.npmjs.org'+- name: Get version from tagid: get_versionrun: echo "version=${GITHUB_REF#refs/tags/cli@}" >> $GITHUB_OUTPUT- - name: Download all artifacts+ - name: Download all platform artifactsuses: actions/download-artifact@v8with:path: artifacts@@ -151,43 +180,36 @@ jobs:- name: Display artifact structurerun: ls -R artifacts/- - name: Create GitHub Release- uses: softprops/action-gh-release@v2- with:- name: CLI v${{ steps.get_version.outputs.version }}- body: |- # OpenViking CLI v${{ steps.get_version.outputs.version }}-- ## Installation-- ### Quick Install (macOS/Linux)- ```bash- curl -fsSL https://raw.githubusercontent.com/${{ github.repository }}/refs/tags/cli@${{ steps.get_version.outputs.version }}/crates/ov_cli/install.sh | bash- ```-- ### Manual Installation- Download the appropriate binary for your platform below, extract it, and add it to your PATH.-- The CLI command is simply `ov`:- ```bash- # After extraction- chmod +x ov # Unix only- mv ov /usr/local/bin/ # or any directory in your PATH-- # Verify installation- ov --version- ```-- ### Checksums- SHA256 checksums are provided for each binary for verification.-- ## Changes- See the [commit history](https://github.com/${{ github.repository }}/commits/cli@${{ steps.get_version.outputs.version }}) for details.- files: |- artifacts/**/*.tar.gz- artifacts/**/*.zip- artifacts/**/*.sha256- draft: false- prerelease: ${{ contains(steps.get_version.outputs.version, 'alpha') || contains(steps.get_version.outputs.version, 'beta') || contains(steps.get_version.outputs.version, 'rc') }}+ - name: Publish platform packages+ env:+ NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}+ run: |+ VERSION="${{ steps.get_version.outputs.version }}"+ for pkg_dir in artifacts/cli-*/; do+ pkg_name=$(basename "$pkg_dir")+ echo "Publishing @openviking/$pkg_name@$VERSION..."+ chmod +x "$pkg_dir/bin/ov" 2>/dev/null || true+ cd "$pkg_dir"+ npm publish --access public+ cd "$GITHUB_WORKSPACE"+ done++ - name: Publish wrapper packageenv:- GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}+ NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}+ run: |+ VERSION="${{ steps.get_version.outputs.version }}"+ cd npm/cli++ # Inject version into package.json+ node -e "+ const pkg = JSON.parse(require('fs').readFileSync('package.json', 'utf8'));+ pkg.version = '$VERSION';+ for (const dep of Object.keys(pkg.optionalDependencies || {})) {+ pkg.optionalDependencies[dep] = '$VERSION';+ }+ require('fs').writeFileSync('package.json', JSON.stringify(pkg, null, 2) + '\n');+ "++ echo "Publishing @openviking/cli@$VERSION..."+ npm publish --access publicdiff --git a/crates/ov_cli/Cargo.toml b/crates/ov_cli/Cargo.tomlindex b04fb3c25..c8232e542 100644--- a/crates/ov_cli/Cargo.toml+++ b/crates/ov_cli/Cargo.toml@@ -1,6 +1,6 @@[package]name = "ov_cli"-version = "0.3.14"+version = "0.0.0"edition = "2024"rust-version = "1.91.1"authors = ["OpenViking Contributors"]diff --git a/npm/cli/README.md b/npm/cli/README.mdnew file mode 100644index 000000000..3e35b05ee--- /dev/null+++ b/npm/cli/README.md@@ -0,0 +1,105 @@+# @openviking/cli++Native CLI for [OpenViking](https://github.com/volcengine/openviking) — an agent-native context database for AI workflows.++Store, search, and retrieve context (memories, resources, embeddings) across conversations and agents.++## Install++```bash+npm i -g @openviking/cli+```++This installs the `ov` binary for your platform (macOS, Linux, Windows).++### Alternative install methods++```bash+# via curl+curl -fsSL https://openviking.tos-cn-beijing.volces.com/cli/install.sh | bash++# one-shot with npx+npx @openviking/cli --help+```++## Quick start++```bash+# Check connectivity+ov health++# Store context+ov add-resource ./notes.md+ov add-memory "key insight from today's debugging session"++# Retrieve context+ov find "what did I learn about caching?"+ov ls+ov read /path/to/resource++# Semantic search+ov search "authentication flow"+ov grep "TODO"+```++## Commands++### Data++| Command | Description |+|---------|-------------|+| `add-resource` | Add files or URLs into OpenViking |+| `add-memory` | Store a memory in one shot |+| `add-skill` | Add a skill from a directory or SKILL.md |+| `ls` | List directory contents |+| `tree` | Hierarchical tree view |+| `read` | Read full file content |+| `abstract` | Brief summary (L0) |+| `overview` | Medium detail (L1) |+| `write` | Write or append text content |+| `find` | Semantic retrieval with scoring |+| `search` | Context-aware retrieval (experimental) |+| `grep` | Pattern search with regex |+| `glob` | File glob pattern search |+| `rm` | Remove a resource or directory |+| `mv` | Move or rename a resource |+| `stat` | Get resource metadata |+| `get` | Download file to local path |+| `session` | Manage sessions |+| `export` / `import` | Backup and restore as .ovpack |++### Interactive++| Command | Description |+|---------|-------------|+| `tui` | Interactive file explorer |+| `chat` | Chat with vikingbot agent |++### Status++| Command | Description |+|---------|-------------|+| `health` | Quick health check |+| `status` | Show server components status |+| `config` | Configuration management |+| `version` | Show CLI and server version |+| `task` | Track async processing tasks |++## Supported platforms++| Platform | Architecture | Package |+|----------|-------------|---------|+| macOS | Apple Silicon | `@openviking/cli-darwin-arm64` |+| macOS | Intel | `@openviking/cli-darwin-x64` |+| Linux | x64 | `@openviking/cli-linux-x64` |+| Linux | ARM64 | `@openviking/cli-linux-arm64` |+| Windows | x64 | `@openviking/cli-win32-x64` |++## Links++- [GitHub](https://github.com/volcengine/openviking)+- [Documentation](https://github.com/volcengine/openviking#readme)++## License++Apache-2.0diff --git a/npm/cli/bin/ov.mjs b/npm/cli/bin/ov.mjsnew file mode 100644index 000000000..94222bb15--- /dev/null+++ b/npm/cli/bin/ov.mjs@@ -0,0 +1,29 @@+#!/usr/bin/env node+import { execFileSync } from "node:child_process";+import { createRequire } from "node:module";+import { join } from "node:path";++const require = createRequire(import.meta.url);+const platforms = {+ "darwin-arm64": "@openviking/cli-darwin-arm64",+ "darwin-x64": "@openviking/cli-darwin-x64",+ "linux-arm64": "@openviking/cli-linux-arm64",+ "linux-x64": "@openviking/cli-linux-x64",+ "win32-x64": "@openviking/cli-win32-x64",+};++const key = `${process.platform}-${process.arch}`;+const pkg = platforms[key];+if (!pkg) {+ console.error(`Unsupported platform: ${key}`);+ process.exit(1);+}++const ext = process.platform === "win32" ? ".exe" : "";+const bin = join(require.resolve(`${pkg}/package.json`), "..", "bin", `ov${ext}`);++try {+ execFileSync(bin, process.argv.slice(2), { stdio: "inherit" });+} catch (e) {+ process.exit(e.status ?? 1);+}diff --git a/npm/cli/bin/postinstall.mjs b/npm/cli/bin/postinstall.mjsnew file mode 100644index 000000000..7f053c2df--- /dev/null+++ b/npm/cli/bin/postinstall.mjs@@ -0,0 +1,19 @@+#!/usr/bin/env node+process.stderr.write(`+ ╔═══════════════════════════════════════════════════╗+ ║ OpenViking CLI installed ║+ ╚═══════════════════════════════════════════════════╝++ Usage: ov <command> [options]++ Commands:+ ov health Check server connectivity+ ov search "query" Context-aware semantic search+ ov ls List directory contents+ ov read <uri> Read full file content+ ov add-resource <path> Add files or URLs+ ov add-memory "text" Store a memory+ ov config show Show current configuration++ Run "ov --help" for the full command list.+\n`);diff --git a/npm/cli/package.json b/npm/cli/package.jsonnew file mode 100644index 000000000..ed382886c--- /dev/null+++ b/npm/cli/package.json@@ -0,0 +1,29 @@+{+ "name": "@openviking/cli",+ "version": "0.0.0",+ "description": "OpenViking CLI — agent-native context database",+ "bin": {+ "ov": "bin/ov.mjs"+ },+ "scripts": {+ "postinstall": "node bin/postinstall.mjs"+ },+ "type": "module",+ "files": ["bin", "README.md"],+ "optionalDependencies": {+ "@openviking/cli-darwin-arm64": "0.0.0",+ "@openviking/cli-darwin-x64": "0.0.0",+ "@openviking/cli-linux-arm64": "0.0.0",+ "@openviking/cli-linux-x64": "0.0.0",+ "@openviking/cli-win32-x64": "0.0.0"+ },+ "keywords": ["openviking", "cli", "context", "embeddings", "agent", "memory"],+ "license": "Apache-2.0",+ "repository": {+ "type": "git",+ "url": "git+https://github.com/volcengine/openviking.git"+ },+ "publishConfig": {+ "access": "public"+ }+}