@qvac/registry-client 0.1.4

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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,291 @@
+# @tetherto/qvac-lib-registry-client
+
+Read-only client library for querying the QVAC Registry. It replicates the registry HyperDB via Hyperswarm and provides APIs for searching and retrieving model information.
+
+## Features
+
+- Establishes replication connection to the QVAC Registry swarm.
+- Supports querying specific models by path, engine, name, and quantization.
+- Downloads actual model files from Hyperblobs cores via blind peers.
+- Provides indexed search methods for efficient lookups.
+- Graceful disconnection from the swarm.
+
+## Installation
+
+```bash
+npm install @tetherto/qvac-lib-registry-client
+```
+
+Ensure the registry core key is available via environment variables or provided via options.
+
+## Usage
+
+### Basic Example
+
+```javascript
+'use strict'
+const { QVACRegistryClient } = require('@tetherto/qvac-lib-registry-client')
+
+async function main () {
+  const client = new QVACRegistryClient({
+    registryCoreKey: process.env.QVAC_REGISTRY_CORE_KEY
+  })
+
+  const models = await client.findModels({})
+  console.log('All models:', models)
+
+  if (models.length > 0) {
+    const model = await client.getModel(models[0].path, models[0].source)
+    console.log('Model:', model)
+  }
+
+  await client.close()
+}
+main().catch(console.error)
+```
+
+### Available Methods
+
+#### Lifecycle
+
+- `ready()`: Initialize client and connect to registry. Triggered from constructor asynchronously.
+- `close()`: Close connection to registry and corestore.
+
+#### Metadata Queries
+
+- `getModel(path, source)`: Retrieves a specific model's metadata by path and source.
+- `findModels(query)`: General search with filters. Supports path prefix queries for finding model shards.
+- `findModelsByEngine(query)`: Searches models by engine (indexed).
+- `findModelsByName(query)`: Searches models by name (indexed).
+- `findModelsByQuantization(query)`: Searches models by quantization (indexed).
+
+Query format for range queries:
+
+```javascript
+// Exact match
+const models = await client.findModelsByEngine({
+  gte: { engine: '@qvac/transcription-whispercpp' },
+  lte: { engine: '@qvac/transcription-whispercpp' }
+})
+
+// Prefix match (all models with path starting with 'hf/')
+const hfModels = await client.findModels({
+  gte: { path: 'hf/' },
+  lte: { path: 'hf/\uffff' }
+})
+```
+
+#### File Downloads
+
+- `downloadModel(path, source, options)`: Downloads actual model file from Hyperblobs cores.
+  - `path`: Registry path of the model (e.g., 'hf/model.gguf')
+  - `source`: Source identifier (e.g., 'hf')
+  - `options`:
+    - `timeout`: Download timeout in ms (default: 30000)
+    - `outputFile`: Optional file path to save directly to disk
+  - Returns: `{ model: QVACModelEntry, artifact: QVACDownloadedArtifact }`
+    - If `outputFile` provided: `artifact = { path: '/path/to/file' }`
+    - Otherwise: `artifact = { stream: ReadableStream }`
+
+Example - Download to file:
+
+```javascript
+const result = await client.downloadModel('hf/ggml-tiny.bin', 'hf', {
+  outputFile: './downloaded/whisper-tiny.ggml',
+  timeout: 60000
+})
+console.log('Downloaded to:', result.artifact.path)
+console.log('Model metadata:', result.model)
+```
+
+Example - Download as stream:
+
+```javascript
+const result = await client.downloadModel('hf/ggml-tiny.bin', 'hf')
+const fs = require('fs')
+result.artifact.stream.pipe(fs.createWriteStream('./model.ggml'))
+```
+
+## CLI
+
+The package includes a CLI for querying and downloading models from the registry.
+
+```bash
+npx qvac-registry --help
+```
+
+### List models
+
+By default, `list` prints a compact table with path, source, quantization, and params:
+
+```bash
+$ qvac-registry list
+Found 195 model(s)
+
+PATH	SOURCE	QUANT	PARAMS
+BSC-LT/salamandraTA-2B-instruct-GGUF/blob/60046856fcac87c47fb0c706e994e70f01eda62b/salamandrata_2b_inst_q4.gguf	hf	q4	2B
+Qwen/Qwen3-8B-GGUF/blob/main/Qwen3-8B-Q4_K_M.gguf	hf	q4_k_m	8B
+ggerganov/whisper.cpp/resolve/5359861c739e955e79d9a303bcbc70fb988958b1/ggml-tiny-q8_0.bin	hf	q8_0
+...
+```
+
+Use `--full` for detailed output per model:
+
+```bash
+$ qvac-registry list --full
+Found 195 model(s)
+
+  Qwen/Qwen3-8B-GGUF/blob/main/Qwen3-8B-Q4_K_M.gguf
+    source:       hf
+    engine:       @qvac/llm-llamacpp
+    quantization: q4_k_m
+    params:       8B
+    size:         4.68 GB
+    license:      Apache-2.0
+    sha256:       d98cdcbd03e17ce47681435b5150e34c1417f50b5c0019dd560e4882c5745785
+...
+```
+
+### Filter models
+
+```bash
+# By engine
+$ qvac-registry list --engine @qvac/transcription-whispercpp
+
+# By quantization
+$ qvac-registry list -q q4_k_m
+
+# By name (case-sensitive prefix match on filename)
+$ qvac-registry list -n Qwen3
+
+# Combined
+$ qvac-registry list -e @qvac/llm-llamacpp -q q4_k_m --full
+```
+
+### Get a specific model
+
+```bash
+$ qvac-registry get \
+    "ggerganov/whisper.cpp/resolve/5359861c739e955e79d9a303bcbc70fb988958b1/ggml-tiny-q8_0.bin" hf
+
+  ggerganov/whisper.cpp/resolve/5359861c739e955e79d9a303bcbc70fb988958b1/ggml-tiny-q8_0.bin
+    source:       hf
+    engine:       @qvac/transcription-whispercpp
+    quantization: q8_0
+    size:         41.52 MB
+    license:      MIT
+    sha256:       ...
+```
+
+### Download a model
+
+```bash
+$ qvac-registry download \
+    "ggerganov/whisper.cpp/resolve/5359861c739e955e79d9a303bcbc70fb988958b1/ggml-tiny-q8_0.bin" hf \
+    --output ./ggml-tiny-q8_0.bin
+Downloading ... -> /absolute/path/ggml-tiny-q8_0.bin
+Download complete: 41.52 MB
+```
+
+### JSON output
+
+All commands support `--json` for machine-readable output:
+
+```bash
+$ qvac-registry list --engine @qvac/transcription-whispercpp --json | jq '.[0].path'
+```
+
+### Global flags
+
+```
+--key|-k [key]        Registry core key (overrides QVAC_REGISTRY_CORE_KEY env)
+--storage|-s [path]   Client storage path
+--verbose|-v          Enable verbose/debug logging
+```
+
+## Examples
+
+See the `examples/` folder for complete working examples:
+
+- `example.js`: List models, query by engine/name/quantization, find shards
+- `download-model.js`: Download a single model to disk
+- `download-all-models.js`: Download all models in the registry
+
+Run examples:
+
+```bash
+cd client
+node examples/example.js
+node examples/download-model.js
+node examples/download-all-models.js
+```
+
+## Configuration
+
+- `storage`: Path for local storage (defaults to temporary directory in `os.tmpdir()`, or `REGISTRY_STORAGE` env var if set).
+- `registryCoreKey`: z-base-32 or hex string of the hypercore key (defaults to `QVAC_REGISTRY_CORE_KEY` env var).
+- `logger`: Logger configuration object
+  - `level`: Log level ('debug', 'info', 'warn', 'error')
+  - `name`: Logger name for identification
+
+### Storage Configuration
+
+By default, the client uses a temporary directory created in `os.tmpdir()` with a unique name. Temporary storage is used for replicating registry metadata and is separate from downloaded model files. The temporary storage is not automatically cleaned up on exit and should be manually removed if needed. If you need persistent storage or want to control the location:
+
+```javascript
+const client = new QVACRegistryClient({
+  registryCoreKey: process.env.QVAC_REGISTRY_CORE_KEY,
+  storage: '/path/to/persistent/storage'
+})
+```
+
+### Environment Variables
+
+- `QVAC_REGISTRY_CORE_KEY`: Core key for accessing the registry hypercore
+- `REGISTRY_STORAGE`: Path for local storage (optional, overrides temporary directory default)
+
+## Error Handling
+
+The client uses custom error codes in the range 19001-20000. All errors extend `QvacErrorRegistryClient`.
+
+### Error Codes
+
+| Code | Name | Description | When Thrown |
+|------|------|-------------|-------------|
+| 19001 | FAILED_TO_CONNECT | Connection to registry failed | Missing core key, network issues during initialization |
+| 19002 | FAILED_TO_CLOSE | Failed to close registry cleanly | Resource cleanup errors during shutdown |
+| 19003 | MODEL_NOT_FOUND | Model not found or invalid | Model doesn't exist or missing blob binding |
+
+### Error Handling Example
+
+```javascript
+const { QVACRegistryClient } = require('@tetherto/qvac-lib-registry-client')
+const { QvacErrorRegistryClient } = require('@tetherto/qvac-lib-registry-client/utils/error')
+
+async function handleErrors () {
+  const client = new QVACRegistryClient({
+    registryCoreKey: process.env.QVAC_REGISTRY_CORE_KEY
+  })
+
+  try {
+    const model = await client.getModel('hf/model-name.Q4_K_M.gguf', 'hf')
+    if (!model) {
+      console.log('Model not found')
+    } else {
+      console.log('Model found:', model)
+    }
+  } catch (error) {
+    if (error instanceof QvacErrorRegistryClient) {
+      console.error(`Registry error [${error.code}]:`, error.message)
+    } else {
+      console.error('Unexpected error:', error)
+    }
+  } finally {
+    await client.close()
+  }
+}
+```
+
+## License
+
+Apache-2.0

package/bin/cli.js

@@ -0,0 +1,208 @@
+#!/usr/bin/env node
+'use strict'
+
+const { command, flag, arg, summary, header, footer, description } = require('paparam')
+const { QVACRegistryClient } = require('../index')
+const IdEnc = require('hypercore-id-encoding')
+const path = require('path')
+
+const VERSION = require('../package.json').version
+
+// --- Helpers ---
+
+function createClient (parentFlags) {
+  const opts = {}
+  if (parentFlags.key) opts.registryCoreKey = parentFlags.key
+  if (parentFlags.storage) opts.storage = parentFlags.storage
+  if (parentFlags.verbose) {
+    opts.logger = { level: 'debug', enabled: true }
+  } else {
+    opts.logger = { enabled: false }
+  }
+  return new QVACRegistryClient(opts)
+}
+
+function getRootFlags (cmd) {
+  let current = cmd
+  while (current.parent) current = current.parent
+  return current.flags || {}
+}
+
+function formatSize (bytes) {
+  if (!bytes) return 'N/A'
+  if (bytes >= 1024 * 1024 * 1024) return (bytes / (1024 * 1024 * 1024)).toFixed(2) + ' GB'
+  if (bytes >= 1024 * 1024) return (bytes / (1024 * 1024)).toFixed(2) + ' MB'
+  if (bytes >= 1024) return (bytes / 1024).toFixed(2) + ' KB'
+  return bytes + ' B'
+}
+
+function printModelCompact (model) {
+  const parts = [model.path, model.source]
+  if (model.quantization) parts.push(model.quantization)
+  if (model.params) parts.push(model.params)
+  console.log(parts.join('\t'))
+}
+
+function printModelFull (model, opts = {}) {
+  const blob = model.blobBinding || {}
+  const coreKey = blob.coreKey ? IdEnc.normalize(blob.coreKey) : 'N/A'
+
+  console.log(`  ${model.path}`)
+  console.log(`    source:       ${model.source}`)
+  console.log(`    engine:       ${model.engine}`)
+  if (model.name) console.log(`    name:         ${model.name}`)
+  if (model.quantization) console.log(`    quantization: ${model.quantization}`)
+  if (model.params) console.log(`    params:       ${model.params}`)
+  console.log(`    size:         ${formatSize(blob.byteLength || model.sizeBytes)}`)
+  if (model.licenseId || model.license) console.log(`    license:      ${model.licenseId || model.license}`)
+  if (blob.sha256 || model.sha256) console.log(`    sha256:       ${blob.sha256 || model.sha256}`)
+  if (opts.verbose && model.description) console.log(`    description:  ${model.description}`)
+  if (opts.verbose) console.log(`    blob core:    ${coreKey}`)
+  if (model.deprecated) console.log('    deprecated:   true')
+  console.log()
+}
+
+async function withClient (cmd, fn) {
+  const rootFlags = getRootFlags(cmd)
+  const client = createClient(rootFlags)
+  try {
+    await fn(client, rootFlags)
+  } finally {
+    await client.close()
+  }
+}
+
+// --- Commands ---
+
+const listCmd = command('list',
+  summary('List models from the registry'),
+  description('List all models or filter by name, engine, or quantization.'),
+  flag('--name|-n [name]', 'Filter by model name (partial match)'),
+  flag('--engine|-e [engine]', 'Filter by engine (exact match)'),
+  flag('--quantization|-q [quantization]', 'Filter by quantization (partial match)'),
+  flag('--full', 'Show full model details'),
+  flag('--include-deprecated', 'Include deprecated models'),
+  flag('--json', 'Output as JSON'),
+  async function (cmd) {
+    await withClient(cmd, async (client, rootFlags) => {
+      const { flags } = cmd
+      const params = {}
+      if (flags.name) params.name = flags.name
+      if (flags.engine) params.engine = flags.engine
+      if (flags.quantization) params.quantization = flags.quantization
+      if (flags.includeDeprecated) params.includeDeprecated = true
+
+      const hasFilters = flags.name || flags.engine || flags.quantization
+      let models
+
+      if (hasFilters) {
+        models = await client.findBy(params)
+      } else {
+        models = await client.findModels({}, { includeDeprecated: !!flags.includeDeprecated })
+      }
+
+      if (flags.json) {
+        const out = models.map(m => ({
+          ...m,
+          blobBinding: m.blobBinding
+            ? { ...m.blobBinding, coreKey: m.blobBinding.coreKey ? IdEnc.normalize(m.blobBinding.coreKey) : undefined }
+            : undefined
+        }))
+        console.log(JSON.stringify(out, null, 2))
+        return
+      }
+
+      console.log(`Found ${models.length} model(s)\n`)
+
+      if (flags.full) {
+        for (const m of models) {
+          printModelFull(m, { verbose: rootFlags.verbose })
+        }
+      } else {
+        console.log(['PATH', 'SOURCE', 'QUANT', 'PARAMS'].join('\t'))
+        for (const m of models) {
+          printModelCompact(m)
+        }
+      }
+    })
+  }
+)
+
+const getCmd = command('get',
+  summary('Get a specific model by path and source'),
+  arg('<path>', 'Model path (e.g. hf/org/repo/file.gguf)'),
+  arg('<source>', 'Model source (e.g. hf, s3)'),
+  flag('--json', 'Output as JSON'),
+  async function (cmd) {
+    await withClient(cmd, async (client, rootFlags) => {
+      const modelPath = cmd.args.path
+      const source = cmd.args.source
+
+      const model = await client.getModel(modelPath, source)
+      if (!model) {
+        console.error(`Model not found: ${modelPath} (source: ${source})`)
+        process.exit(1)
+      }
+
+      if (cmd.flags.json) {
+        const out = {
+          ...model,
+          blobBinding: model.blobBinding
+            ? { ...model.blobBinding, coreKey: model.blobBinding.coreKey ? IdEnc.normalize(model.blobBinding.coreKey) : undefined }
+            : undefined
+        }
+        console.log(JSON.stringify(out, null, 2))
+        return
+      }
+
+      printModelFull(model, { verbose: rootFlags.verbose })
+    })
+  }
+)
+
+const downloadCmd = command('download',
+  summary('Download a model from the registry'),
+  arg('<path>', 'Model path'),
+  arg('<source>', 'Model source (e.g. hf, s3)'),
+  flag('--output|-o <file>', 'Output file path (required)'),
+  flag('--timeout|-t [ms]', 'Download timeout in ms (default: 30000)'),
+  async function (cmd) {
+    await withClient(cmd, async (client) => {
+      const { flags } = cmd
+      const modelPath = cmd.args.path
+      const source = cmd.args.source
+
+      if (!flags.output) {
+        console.error('--output|-o is required')
+        process.exit(1)
+      }
+
+      const outputFile = path.resolve(flags.output)
+      const opts = { outputFile }
+      if (flags.timeout) opts.timeout = parseInt(flags.timeout, 10)
+
+      console.log(`Downloading ${modelPath} (${source}) -> ${outputFile}`)
+
+      const result = await client.downloadModel(modelPath, source, opts)
+      const size = result.model.blobBinding?.byteLength || 0
+
+      console.log(`Download complete: ${formatSize(size)}`)
+    })
+  }
+)
+
+// --- Root command ---
+
+const cmd = command('qvac-registry',
+  header(`qvac-registry v${VERSION}`),
+  summary('QVAC Model Registry CLI'),
+  footer('Set QVAC_REGISTRY_CORE_KEY env var or use --key to specify the registry core key.'),
+  flag('--key|-k [key]', 'Registry core key (overrides QVAC_REGISTRY_CORE_KEY env)'),
+  flag('--storage|-s [path]', 'Client storage path'),
+  flag('--verbose|-v', 'Enable verbose/debug logging'),
+  listCmd,
+  getCmd,
+  downloadCmd
+)
+
+cmd.parse()

package/index.d.ts

@@ -0,0 +1,84 @@
+export interface QVACBlobBinding {
+  coreKey: Buffer
+  blockOffset: number
+  blockLength: number
+  byteOffset: number
+  byteLength: number
+}
+
+export interface QVACModelEntry {
+  path: string
+  source: string
+  engine: string
+  license: string
+  name: string
+  sizeBytes: number
+  sha256: string
+  quantization?: string
+  params?: string
+  description?: string
+  notes?: string
+  tags?: string[]
+  blobBinding: QVACBlobBinding
+}
+
+export interface QVACDownloadedArtifactStream {
+  stream: NodeJS.ReadableStream
+}
+
+export interface QVACDownloadedArtifactPath {
+  path: string
+}
+
+export type QVACDownloadedArtifact = QVACDownloadedArtifactStream | QVACDownloadedArtifactPath
+
+export interface QVACDownloadResult {
+  model: QVACModelEntry
+  artifact: QVACDownloadedArtifact
+}
+
+export interface QVACDownloadOptions {
+  timeout?: number
+  peerTimeout?: number
+  outputFile?: string
+}
+
+export interface QVACRegistryClientOptions {
+  storage?: string
+  registryCoreKey?: string
+  logger?: any
+}
+
+export interface QVACModelQuery {
+  gte?: Record<string, any>
+  lte?: Record<string, any>
+  gt?: Record<string, any>
+  lt?: Record<string, any>
+}
+
+export interface FindByParams {
+  /** Filter by name (partial match, case-insensitive) */
+  name?: string
+  /** Filter by engine (exact match) */
+  engine?: string
+  /** Filter by quantization (partial match, case-insensitive) */
+  quantization?: string
+  /** Include deprecated models (default: false) */
+  includeDeprecated?: boolean
+}
+
+export class QVACRegistryClient {
+  constructor (opts?: QVACRegistryClientOptions)
+
+  ready (): Promise<void>
+  close (): Promise<void>
+
+  getModel (path: string, source: string): Promise<QVACModelEntry | null>
+  downloadModel (path: string, source: string, options?: QVACDownloadOptions): Promise<QVACDownloadResult>
+
+  findBy (params?: FindByParams): Promise<QVACModelEntry[]>
+  findModels (query?: QVACModelQuery): Promise<QVACModelEntry[]>
+  findModelsByEngine (query?: QVACModelQuery): Promise<QVACModelEntry[]>
+  findModelsByName (query?: QVACModelQuery): Promise<QVACModelEntry[]>
+  findModelsByQuantization (query?: QVACModelQuery): Promise<QVACModelEntry[]>
+}

package/index.js

@@ -0,0 +1,7 @@
+'use strict'
+
+const QVACRegistryClient = require('./lib/client')
+
+module.exports = {
+  QVACRegistryClient
+}

package/lib/client.js

@@ -0,0 +1,322 @@
+'use strict'
+
+const { QvacErrorRegistryClient, ERR_CODES } = require('../utils/error')
+const RegistryConfig = require('./config')
+const { RegistryDatabase } = require('@qvac/registry-schema')
+const ReadyResource = require('ready-resource')
+const Logger = require('./logger')
+const Corestore = require('corestore')
+const Hyperswarm = require('hyperswarm')
+const Hyperblobs = require('hyperblobs')
+const IdEnc = require('hypercore-id-encoding')
+const path = require('path')
+const fs = require('fs')
+
+class QVACRegistryClient extends ReadyResource {
+  constructor (opts = {}) {
+    super()
+
+    this.logger = new Logger(opts.logger)
+    this.registryConfig = new RegistryConfig({ logger: this.logger })
+
+    this.db = null
+    this.corestore = null
+    this.hyperswarm = null
+    this._connectionHandler = null
+
+    this.storage = this.registryConfig.getRegistryStorage(opts.storage)
+    this.registryCoreKey = this.registryConfig.getRegistryCoreKey(opts.registryCoreKey)
+
+    this.logger.debug('Initializing QVAC Registry Client', {
+      mode: 'read',
+      registryCoreKey: opts.registryCoreKey ? '***' : 'not provided'
+    })
+
+    this.ready()
+  }
+
+  async _open () {
+    this.logger.debug('_open called')
+
+    if (!this.registryCoreKey) {
+      this.logger.error('Missing registry core key for read mode')
+      throw new QvacErrorRegistryClient({ code: ERR_CODES.FAILED_TO_CONNECT, adds: 'Missing registry core key. Set QVAC_REGISTRY_CORE_KEY environment variable.' })
+    }
+
+    this.logger.debug('Creating corestore for open')
+    this.corestore = new Corestore(this.storage)
+    await this.corestore.ready()
+
+    this.logger.debug('Creating Hyperswarm for open')
+    this.hyperswarm = new Hyperswarm()
+
+    this._connectionHandler = (conn, peerInfo) => {
+      this.logger.debug('Client peer connected', { peer: IdEnc.normalize(peerInfo.publicKey) })
+      this.corestore.replicate(conn)
+    }
+    this.hyperswarm.on('connection', this._connectionHandler)
+
+    const viewKey = IdEnc.decode(this.registryCoreKey)
+    const viewCore = this.corestore.get({ key: viewKey })
+    await viewCore.ready()
+
+    this.logger.debug('Joining hyperswarm for registry view', {
+      viewKey: IdEnc.normalize(viewCore.key),
+      discoveryKey: IdEnc.normalize(viewCore.discoveryKey)
+    })
+
+    this.hyperswarm.join(viewCore.discoveryKey, { client: true, server: false })
+    await this.hyperswarm.flush()
+
+    this.logger.debug('Waiting for view core sync')
+    await viewCore.update({ wait: true })
+
+    this.logger.debug('Creating RegistryDatabase from view core')
+    this.db = new RegistryDatabase(viewCore, { extension: false })
+    await this.db.ready()
+
+    this.logger.debug('QVACRegistryClient ready', {
+      length: viewCore.length
+    })
+  }
+
+  async getModel (path, source) {
+    this._validateString(path, 'path')
+    this._validateString(source, 'source')
+
+    try {
+      this.logger.info('Getting model', { path, source })
+      await this.ready()
+
+      const result = await this.db.getModel(path, source)
+      this.logger.debug('getModel result', { result })
+      return result ?? null
+    } catch (error) {
+      this.logger.error('Error getting model', error)
+      throw error
+    }
+  }
+
+  async findModels (query = {}, opts = {}) {
+    await this.ready()
+    const { includeDeprecated = false } = opts
+    this.logger.debug('findModels called', { query, includeDeprecated })
+
+    let models = await this.db.findModelsByPath(query).toArray()
+
+    if (!includeDeprecated) {
+      models = models.filter(m => !m.deprecated)
+    }
+
+    return models
+  }
+
+  async findModelsByEngine (query = {}) {
+    await this.ready()
+    this.logger.debug('findModelsByEngine called', { query })
+    return this.db.findModelsByEngine(query).toArray()
+  }
+
+  async findModelsByName (query = {}) {
+    await this.ready()
+    this.logger.debug('findModelsByName called', { query })
+    return this.db.findModelsByName(query).toArray()
+  }
+
+  async findModelsByQuantization (query = {}) {
+    await this.ready()
+    this.logger.debug('findModelsByQuantization called', { query })
+    return this.db.findModelsByQuantization(query).toArray()
+  }
+
+  /**
+   * Find models with optional filters.
+   * Uses the database's findBy method for efficient indexed queries.
+   * @param {Object} params - Filter parameters
+   * @param {string} [params.name] - Filter by name (partial match)
+   * @param {string} [params.engine] - Filter by engine (exact match)
+   * @param {string} [params.quantization] - Filter by quantization (partial match)
+   * @param {boolean} [params.includeDeprecated=false] - Include deprecated models
+   * @returns {Promise<Array>} Array of matching models
+   */
+  async findBy (params = {}) {
+    await this.ready()
+    this.logger.debug('findBy called', { params })
+    return this.db.findBy(params)
+  }
+
+  _validateString (value, name) {
+    if (typeof value !== 'string' || value.length === 0) {
+      throw new Error(`Invalid ${name}: ${value}`)
+    }
+  }
+
+  async _getBlobsCore (blobsCoreKey) {
+    const keyBuffer = Buffer.isBuffer(blobsCoreKey)
+      ? blobsCoreKey
+      : Buffer.from(blobsCoreKey.data || blobsCoreKey, 'hex')
+
+    this.logger.debug('Creating hyperblobs core', {
+      blobCore: IdEnc.normalize(keyBuffer)
+    })
+
+    const core = this.corestore.get({ key: keyBuffer })
+    await core.ready()
+
+    const blobs = new Hyperblobs(core)
+    await blobs.ready()
+
+    return { core, blobs }
+  }
+
+  async downloadModel (path, source, options = {}) {
+    this._validateString(path, 'path')
+    this._validateString(source, 'source')
+
+    if (options && typeof options !== 'object') {
+      throw new Error(`Invalid options: ${typeof options}`)
+    }
+
+    let core, blobs
+
+    try {
+      this.logger.info('Downloading model', { path, source })
+      await this.ready()
+
+      const model = await this.getModel(path, source)
+      if (!model) {
+        throw new QvacErrorRegistryClient({ code: ERR_CODES.MODEL_NOT_FOUND, adds: `Model not found: ${path} (source: ${source})` })
+      }
+
+      if (!model.blobBinding || !model.blobBinding.coreKey) {
+        throw new QvacErrorRegistryClient({ code: ERR_CODES.MODEL_NOT_FOUND, adds: 'Model missing blob binding' })
+      }
+
+      this.logger.debug('Model metadata retrieved', { model })
+
+      const blobsCore = await this._getBlobsCore(model.blobBinding.coreKey)
+      core = blobsCore.core
+      blobs = blobsCore.blobs
+
+      this.logger.debug('Joining swarm for blobs core', {
+        discoveryKey: IdEnc.normalize(core.discoveryKey)
+      })
+
+      this.hyperswarm.join(core.discoveryKey, { client: true, server: false })
+      await this.hyperswarm.flush()
+
+      await core.update({ wait: true })
+      this.logger.debug('Blobs core updated')
+
+      let artifact
+      if (options.outputFile) {
+        await this._streamBlobToFile(blobs, model.blobBinding, options.outputFile, options)
+        artifact = { path: options.outputFile }
+
+        if (blobs) await blobs.close()
+        if (core) await core.close()
+      } else {
+        const stream = blobs.createReadStream(model.blobBinding, {
+          wait: true,
+          timeout: options.timeout || 30000
+        })
+        artifact = { stream }
+
+        const cleanup = async () => {
+          if (blobs) {
+            try {
+              await blobs.close()
+            } catch (cleanupError) {
+              this.logger.warn('Error closing blob instance', { error: cleanupError.message })
+            }
+          }
+          if (core) {
+            try {
+              await core.close()
+            } catch (cleanupError) {
+              this.logger.warn('Error closing blob core', { error: cleanupError.message })
+            }
+          }
+          this.logger.debug('Blob resources closed after stream end')
+        }
+
+        stream.on('close', cleanup)
+      }
+
+      this.logger.info('Model downloaded successfully')
+
+      return {
+        model,
+        artifact
+      }
+    } catch (error) {
+      this.logger.error('Error downloading model', error)
+
+      if (blobs) {
+        try {
+          await blobs.close()
+        } catch (cleanupError) {
+          this.logger.warn('Error closing blob instance on error', { error: cleanupError.message })
+        }
+      }
+      if (core) {
+        try {
+          await core.close()
+        } catch (cleanupError) {
+          this.logger.warn('Error closing blob core on error', { error: cleanupError.message })
+        }
+      }
+
+      throw error
+    }
+  }
+
+  async _streamBlobToFile (blobs, blobPointer, filePath, options) {
+    const stream = blobs.createReadStream(blobPointer, {
+      wait: true,
+      timeout: options.timeout || 30000
+    })
+
+    const dir = path.dirname(filePath)
+    await fs.promises.mkdir(dir, { recursive: true })
+
+    const writeStream = fs.createWriteStream(filePath)
+
+    return new Promise((resolve, reject) => {
+      stream.pipe(writeStream)
+      writeStream.on('finish', resolve)
+      writeStream.on('error', reject)
+      stream.on('error', reject)
+    })
+  }
+
+  async _close () {
+    this.logger.debug('_close called')
+
+    if (this.db) {
+      this.logger.debug('Closing database')
+      await this.db.close()
+      this.db = null
+    }
+
+    if (this.hyperswarm) {
+      if (this._connectionHandler) {
+        this.hyperswarm.off('connection', this._connectionHandler)
+        this._connectionHandler = null
+      }
+      this.logger.debug('Destroying hyperswarm')
+      await this.hyperswarm.destroy()
+      this.hyperswarm = null
+    }
+
+    if (this.corestore) {
+      this.logger.debug('Closing corestore')
+      await this.corestore.close()
+      this.corestore = null
+    }
+
+    this.logger.debug('QVACRegistryClient closed')
+  }
+}
+
+module.exports = QVACRegistryClient

package/lib/config.js

@@ -0,0 +1,46 @@
+'use strict'
+
+const { getEnv } = require('../utils/env')
+const { ENV_KEYS } = require('@qvac/registry-schema')
+const Logger = require('./logger')
+const os = require('os')
+const path = require('path')
+
+class RegistryConfig {
+  constructor (opts = {}) {
+    this.logger = new Logger(opts.logger)
+    this.logger.debug('RegistryConfig initialized', { opts })
+  }
+
+  getRegistryStorage (providedPath) {
+    if (providedPath) {
+      this.logger.debug('getRegistryStorage called with providedPath', { providedPath })
+      return providedPath
+    }
+
+    const envPath = getEnv(ENV_KEYS.REGISTRY_STORAGE)
+    const result = envPath || this._createTempStoragePath()
+    this.logger.debug('getRegistryStorage resolved', { envPath, result })
+    return result
+  }
+
+  _createTempStoragePath () {
+    const tmpBase = os.tmpdir()
+    const storageDir = path.join(tmpBase, `qvac-registry-client-${Date.now()}-${Math.random().toString(36).slice(2, 9)}`)
+    this.logger.debug('Created temp storage path', { storageDir })
+    return storageDir
+  }
+
+  getRegistryCoreKey (providedKey) {
+    if (providedKey) {
+      this.logger.debug('getRegistryCoreKey called with providedKey', { providedKey })
+      return providedKey
+    }
+
+    const envKey = getEnv(ENV_KEYS.QVAC_REGISTRY_CORE_KEY)
+    this.logger.debug('getRegistryCoreKey loaded from env', { envKey })
+    return envKey || null
+  }
+}
+
+module.exports = RegistryConfig

package/lib/logger.js

@@ -0,0 +1,45 @@
+'use strict'
+
+class Logger {
+  constructor (opts = {}) {
+    this.level = opts.level || 'info'
+    this.name = opts.name || 'QVACRegistryClient'
+    this.enabled = opts.enabled !== false
+
+    this.levels = {
+      debug: 0,
+      info: 1,
+      warn: 2,
+      error: 3
+    }
+  }
+
+  _shouldLog (level) {
+    if (!this.enabled) return false
+    return this.levels[level] >= this.levels[this.level]
+  }
+
+  _log (level, ...args) {
+    if (!this._shouldLog(level)) return
+    const prefix = `[${this.name}] [${level.toUpperCase()}]`
+    console[level](prefix, ...args)
+  }
+
+  debug (...args) {
+    this._log('debug', ...args)
+  }
+
+  info (...args) {
+    this._log('info', ...args)
+  }
+
+  warn (...args) {
+    this._log('warn', ...args)
+  }
+
+  error (...args) {
+    this._log('error', ...args)
+  }
+}
+
+module.exports = Logger

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@qvac/registry-client",
+  "version": "0.1.4",
+  "description": "QVAC Registry client library for read-only queries via Hyperswarm",
+  "license": "Apache-2.0",
+  "type": "commonjs",
+  "main": "index.js",
+  "bin": {
+    "qvac-registry": "./bin/cli.js"
+  },
+  "exports": {
+    ".": "./index.js",
+    "./types": "./index.d.ts"
+  },
+  "files": [
+    "index.js",
+    "index.d.ts",
+    "bin/",
+    "lib/",
+    "utils/",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "test:unit": "brittle tests/unit/*.test.js",
+    "test:unit:bare": "brittle-bare tests/unit/*.test.js",
+    "test": "npm run test:unit && npm run test:integration",
+    "lint": "standard",
+    "lint:fix": "standard --fix",
+    "typecheck": "npx tsc --noEmit"
+  },
+  "dependencies": {
+    "@qvac/error": "^0.1.0",
+    "@qvac/registry-schema": "^0.1.1",
+    "b4a": "^1.6.7",
+    "bare-fs": "^2.1.5",
+    "bare-os": "^2.2.0",
+    "bare-process": "^1.3.0",
+    "corestore": "^6.18.4",
+    "fs": "npm:bare-node-fs",
+    "hyperblobs": "^2.8.0",
+    "hypercore-id-encoding": "^1.3.0",
+    "hyperdb": "^4.16.1",
+    "hyperswarm": "^4.14.0",
+    "os": "npm:bare-node-os",
+    "paparam": "^1.10.0",
+    "path": "npm:bare-node-path",
+    "process": "npm:bare-node-process",
+    "ready-resource": "^1.0.1"
+  },
+  "devDependencies": {
+    "brittle": "^3.4.0",
+    "dotenv": "^17.2.3",
+    "standard": "^17.1.0",
+    "test-tmp": "^1.4.0",
+    "typescript": "^5.9.3"
+  }
+}

package/utils/env.js

@@ -0,0 +1,12 @@
+'use strict'
+
+function getEnv (key, defaultValue = undefined) {
+  if (typeof process !== 'undefined' && process.env && process.env[key] !== undefined) {
+    return process.env[key]
+  }
+  return defaultValue
+}
+
+module.exports = {
+  getEnv
+}

package/utils/error.js

@@ -0,0 +1,36 @@
+'use strict'
+
+const { QvacErrorBase, addCodes } = require('@qvac/error')
+const { name, version } = require('../package.json')
+
+class QvacErrorRegistryClient extends QvacErrorBase { }
+
+// This library has error code range from 19,001 to 20,000
+const ERR_CODES = Object.freeze({
+  FAILED_TO_CONNECT: 19001,
+  FAILED_TO_CLOSE: 19002,
+  MODEL_NOT_FOUND: 19003
+})
+
+addCodes({
+  [ERR_CODES.FAILED_TO_CONNECT]: {
+    name: 'FAILED_TO_CONNECT',
+    message: (message) => `Failed to connect to registry, error: ${message}`
+  },
+  [ERR_CODES.FAILED_TO_CLOSE]: {
+    name: 'FAILED_TO_CLOSE',
+    message: (message) => `Failed to close registry, error: ${message}`
+  },
+  [ERR_CODES.MODEL_NOT_FOUND]: {
+    name: 'MODEL_NOT_FOUND',
+    message: (message) => `Model not found, error: ${message}`
+  }
+}, {
+  name,
+  version
+})
+
+module.exports = {
+  ERR_CODES,
+  QvacErrorRegistryClient
+}