Packaging and operations

python3 scripts/release.py checks the workspace, builds an optimized host executable, prepares a local bundle, smoke-tests the staged executable, and writes an archive plus SHA-256 checksum under target/releases.

The bundle includes the binary, Markdown documentation, both rendered books, schema, examples, source snapshot, dependency notices/inventory and a per-file checksum manifest. RUN.md explains the executable and documentation entrypoints. Nothing is published to a registry or remote hosting service.

Release procedure

1. Make source and documentation changes together.
2. Regenerate the request schema if the command types changed.
3. Run python3 scripts/docs.py to update generated operation pages.
4. Run the release script. It reruns the full gate before packaging.
5. Inspect its output and verify the archive checksum before distributing it in an authorized context.

Existing release archives are not silently overwritten. Use a new release version when the distributable changes. A project’s source license and publication policy are separate from successful local packaging; this project has not selected a license for its new code.

Running the process

Use an explicit database path on a supported local filesystem. Keep the executable version and frozen schema information with backups. The process runs in the foreground; a service manager, model runtime or scheduler belongs to the consuming application.

Monitor stderr, exit status, database size and operation latency. Ordinary request errors return JSON and allow later requests to proceed, so a long-lived client must inspect individual responses rather than waiting for process exit.

Backup and restore

Stop writers before copying a database, or use SQLite’s backup facilities. An in-flight journal and database file must not be treated as unrelated files. Restore to a separate path, open it with the matching release, and read representative or all registered journals through get_ledger to validate their histories before resuming writes.

The adapter rejects unknown application/schema versions; it does not invent a migration. Future migrations need explicit source/target versions, transactional changes, rollback behavior and tests against representative old records.

Offline documentation

The rendered mdBooks include local assets and search. They disable Rust Playground execution so clicking a code example does not depend on a remote compiler. External research citations remain links; reading the local book itself does not require fetching them.

To inspect documentation from a source checkout, open the generated files under target/books. For live editing, mdBook can serve an individual source book locally. The release package includes the generated output, so readers do not need Rust or mdBook merely to read it.