@fgv/ks 5.1.0-25

package/README.md

@@ -0,0 +1,58 @@
+# @fgv/ks
+
+Command-line tool for creating, managing, and exporting ts-extras keystores.
+
+## Features
+
+- Create a keystore at `~/.fgv-ks` by default
+- Change the keystore password
+- Add, list, read, and remove secrets without putting them on the command line
+- Export secrets through a template rendered to a POSIX shell snippet
+- Prompt interactively for missing secrets and optionally persist them
+- Copy rendered output to the clipboard
+
+## Usage
+
+```bash
+ks --help
+```
+
+### Self-contained help topics
+
+```bash
+ks help
+ks help commands
+ks help password
+ks help template
+```
+
+### Initialize a keystore
+
+```bash
+ks init
+```
+
+### Put a secret from stdin or a file
+
+```bash
+printf '%s' "$XAI_API_KEY" | ks put xai --stdin
+ks put xai --file ./xai.txt
+```
+
+### Export secrets into shell variables
+
+```bash
+eval "$(ks export --template-file ./keystore.template.sh)"
+```
+
+### Start a shell session with the keystore password
+
+```bash
+eval "$(ks session --var FGV_KS_PASSWORD)"
+```
+
+### Copy rendered output to the clipboard
+
+```bash
+ks export --template-string 'export XAI_API_KEY={{xai}}' --clipboard
+```

package/bin/ks.js

@@ -0,0 +1,18 @@
+#!/usr/bin/env node
+
+const { KsCli } = require('../lib/index');
+
+async function main() {
+  try {
+    const cli = new KsCli();
+    await cli.run(process.argv);
+  } catch (error) {
+    console.error('Fatal error:', error.message);
+    process.exit(1);
+  }
+}
+
+main().catch((error) => {
+  console.error('Unhandled error:', error);
+  process.exit(1);
+});

package/config/jest.config.json

@@ -0,0 +1,12 @@
+{
+  "testMatch": ["<rootDir>/src/test/**/*.test.ts", "<rootDir>/test/**/*.test.ts"],
+  "preset": "ts-jest",
+  "testEnvironment": "node",
+  "extensionsToTreatAsEsm": [],
+  "moduleNameMapper": {
+    "^clipboardy$": "<rootDir>/test/mocks/clipboardy.js"
+  },
+  "transform": {
+    "^.+\\.ts$": ["ts-jest", { "tsconfig": "tsconfig.test.json" }]
+  }
+}

package/config/rig.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/rig-package/rig.schema.json",
+  "rigPackageName": "@rushstack/heft-node-rig"
+}

package/eslint.config.js

@@ -0,0 +1,24 @@
+// ESLint 9 flat config
+const nodeProfile = require('@rushstack/eslint-config/flat/profile/node');
+const packletsPlugin = require('@rushstack/eslint-config/flat/mixins/packlets');
+const tsdocPlugin = require('@rushstack/eslint-config/flat/mixins/tsdoc');
+
+module.exports = [
+  ...nodeProfile,
+  packletsPlugin,
+  ...tsdocPlugin,
+  {
+    files: ['test/**/*.ts'],
+    languageOptions: {
+      parserOptions: {
+        project: './tsconfig.test.json',
+        tsconfigRootDir: __dirname
+      }
+    }
+  },
+  {
+    rules: {
+      '@rushstack/packlets/mechanics': 'warn'
+    }
+  }
+];

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@fgv/ks",
+  "version": "5.1.0-25",
+  "description": "Command-line utility for managing ts-extras keystore files",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "bin": {
+    "ks": "bin/ks.js"
+  },
+  "scripts": {
+    "build": "heft build --clean",
+    "test": "heft test --clean",
+    "coverage": "heft test --clean --coverage",
+    "clean": "heft clean",
+    "lint": "eslint src --ext .ts",
+    "fixlint": "eslint src --ext .ts --fix"
+  },
+  "keywords": [
+    "keystore",
+    "cli",
+    "tool",
+    "security",
+    "secrets"
+  ],
+  "author": "Erik Fortune",
+  "license": "MIT",
+  "engines": {
+    "node": ">=22.22.0 <23.0.0 || >=24.15.0 <25.0.0"
+  },
+  "dependencies": {
+    "@fgv/ts-extras": "workspace:*",
+    "@fgv/ts-json-base": "workspace:*",
+    "@fgv/ts-utils": "workspace:*",
+    "clipboardy": "^3.0.0",
+    "commander": "^11.0.0"
+  },
+  "devDependencies": {
+    "@fgv/ts-utils-jest": "workspace:*",
+    "@rushstack/eslint-config": "4.6.4",
+    "@rushstack/heft": "1.2.7",
+    "@rushstack/heft-node-rig": "2.11.27",
+    "@rushstack/heft-jest-plugin": "1.2.6",
+    "@types/jest": "^29.5.14",
+    "@types/node": "^20.14.9",
+    "eslint": "^9.39.2",
+    "jest": "^29.7.0",
+    "typescript": "5.9.3",
+    "@types/heft-jest": "1.0.6",
+    "ts-jest": "^29.4.6"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ErikFortune/fgv.git"
+  }
+}