yamlock 0.1.1 → 0.1.2

package/README.md

@@ -13,27 +13,29 @@ Value-level encryption for YAML and JSON configuration files. The name **yamlock
 - Node.js 22.x via `asdf`
 - Yarn Classic (1.x)
 
-## Current status
+## Installation
 
-- Package metadata, linting config, and MIT license are in place.
-- Core crypto helpers (`encryptValue`, `decryptValue`, and supporting utils) work with per-field salts and have unit tests.
-- `processConfig` can walk nested objects/arrays and apply encryption/decryption to every string value.
-- Public API exports (`encryptValue`, `decryptValue`, `processConfig`, `getSupportedAlgorithms`) are wired and verified by tests.
-- Directory structure for source, CLI, tests, and examples exists.
-- CLI binary can encrypt/decrypt YAML and JSON files by calling `processConfig`.
+### npm
 
-## Working locally
+```bash
+npm install -g yamlock      # CLI usage
+npm install yamlock         # project dependency
+```
+
+### Yarn Classic
 
-1. Install the toolchain: `asdf install nodejs 22` and `yarn set version classic` if needed.
-2. Install dependencies with `yarn install`.
-3. Use the scripts below during development.
+```bash
+yarn global add yamlock     # CLI usage
+yarn add yamlock            # project dependency
+```
 
-## Available scripts
+## Features
 
-- `yarn build` — copies the current `src` tree into `dist` (temporary until a real build pipeline appears).
-- `yarn prepare` — invokes `yarn build` automatically when installing from git.
-- `yarn test` — runs Node built-in test runner.
-- `yarn lint` — executes ESLint with the provided config.
+- Encrypt/decrypt individual configuration values with deterministic field-path salts.
+- CLI workflow that processes YAML or JSON files in place.
+- Recursively lock/unlock entire objects via `processConfig`.
+- Public API exports that mirror CLI behavior for programmatic use.
+- Focus on Node.js 22+, ESM modules, and a lightweight dependency set (`js-yaml`).
 
 ## Usage
 
@@ -72,25 +74,19 @@ Every locked string follows the format:
 yl|<algorithm>|<salt_base64>|<iv_base64>|<data_base64>
 ```
 
-where the salt is derived from the full field path. Moving or renaming the field invalidates the salt, preventing accidental decryption in the wrong location.
+Where:
+- yl - format marker prefix
+- <algorithm> - algorithm name (e.g., aes-256-cbc)
+- <salt_base64> - Base64-encoded field path
+- <iv_base64> - Base64-encoded initialization vector
+- <data_base64> - Base64-encoded encrypted data
+
+The salt is derived from the full field path. Moving or renaming the field invalidates the salt, preventing accidental decryption in the wrong location.
 
 ### Key rotation
 
 See [docs/key-rotation.md](docs/key-rotation.md) for a step-by-step guide to rotating `YAMLOCK_KEY` without losing data.
 
-## Project structure
-
-```txt
-yamlock/
-├── src/            # Source files (API, CLI, utilities)
-├── dist/           # Build output created by `yarn build`
-├── bin/            # CLI entry point (loads dist/cli/cli.js)
-├── test/           # Unit and integration suites
-├── examples/       # Usage demos (TBD)
-├── CHANGELOG.md    # Step-by-step release history
-└── README.md / LICENSE
-```
-
 ## Inspiration and motivation
 
 I have worked with Ruby on Rails apps for more than ten years and appreciated how its secret management evolved between 4.2 and 6.x. That flow influenced **yamlock**, but I also explored modern tools such as:
@@ -104,7 +100,7 @@ Each of those projects solves secure config storage differently, yet none fit my
 
 ## Contributing
 
-See [CONTRIBUTING.md](CONTRIBUTING.md) for development workflow, coding standards, and release instructions.
+See [CONTRIBUTING.md](CONTRIBUTING.md) for development workflow, available scripts, and release instructions.
 
 ## Exit codes
 

package/bin/yamlock

@@ -1,6 +1,34 @@
 #!/usr/bin/env node
 
-import('../dist/cli/cli.js').catch((error) => {
-  console.error('[yamlock] CLI failed to start:', error);
-  process.exit(1);
-});
+async function loadCliEntry() {
+  try {
+    const distModule = await import('../dist/cli/cli.js');
+    if (distModule.runCli) {
+      return distModule.runCli;
+    }
+  } catch (error) {
+    if (!(error.code === 'ERR_MODULE_NOT_FOUND' || (error.message && error.message.includes('dist/cli/cli.js')))) {
+      throw error;
+    }
+  }
+
+  try {
+    const srcModule = await import('../src/cli/cli.js');
+    if (srcModule.runCli) {
+      return srcModule.runCli;
+    }
+  } catch (error) {
+    if (!(error.code === 'ERR_MODULE_NOT_FOUND')) {
+      throw error;
+    }
+  }
+
+  throw new Error('CLI entry not found.');
+}
+
+loadCliEntry()
+  .then((runCli) => runCli(process.argv))
+  .catch((error) => {
+    console.error('[yamlock] CLI failed to start:', error);
+    process.exit(1);
+  });

package/dist/cli/cli.js

@@ -87,8 +87,8 @@ function parseArgs(argv) {
   return result;
 }
 
-async function main() {
-  const { command, file, options } = parseArgs(process.argv);
+export async function runCli(argv = process.argv) {
+  const { command, file, options } = parseArgs(argv);
 
   if (!command || !file) {
     print(HELP_TEXT.trim());
@@ -135,5 +135,5 @@ async function main() {
 }
 
 if (import.meta.url === `file://${process.argv[1]}`) {
-  main();
+  runCli();
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yamlock",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Value-level encryption for YAML/JSON configuration files with CLI + Node.js APIs.",
   "license": "MIT",
   "type": "module",