SOCK

SOCK (Sentosa Open Connected Knowledge) is the smallest-useful local registry for experimental Open Knowledge Format bundle networks. It names existing local bundle directories; it does not create, copy, validate, traverse, or modify bundle contents.

Install

Install the sock executable globally from npm:

npm install --global @sentosatech/sock

To install from a source checkout instead:

npm install
npm run build
npm install --global .

Node.js 20 or newer is required.

Commands

sock [--registry PATH] bundle list [--json]
sock [--registry PATH] bundle add HANDLE --path DIRECTORY --description TEXT
sock [--registry PATH] bundle get HANDLE [--json]

For convenience, --registry is accepted before or after the command words. The registry path is selected in this order:

1. --registry
2. OKF_REGISTRY
3. ~/.okf/registry.yaml

bundle add requires an existing directory and stores its canonical absolute path. It does not create a bundle. Handles are registry-local lowercase dot-separated identifiers; internal hyphens are allowed.

bundle list and bundle get report one of four availability values: available, missing, not-directory, or unreadable. A registered bundle does not need to be currently available for get to succeed.

Use --json for deterministic scripting output. Use sock --version to print the package version.

Development

npm install
npm run check
npm run build

The npm lifecycle is publication-ready:

• npm test runs the isolated TypeScript test suite.
• npm run typecheck performs strict static checking.
• npm run check runs both checks.
• npm run prepack creates fresh compiled output.
• prepublishOnly prevents publication unless the full check passes.

Inspect the exact tarball contents without publishing:

npm pack --dry-run

No publication, commit, or remote configuration is performed automatically.

License

MIT