@enjoys/context-engine 1.0.0

package/data/commands/yarn.json

@@ -0,0 +1,28 @@
+{
+  "name": "yarn",
+  "description": "Fast, reliable, and secure JavaScript package manager",
+  "category": "package-manager",
+  "platforms": ["linux", "macos", "windows"],
+  "shells": ["bash", "zsh", "fish", "powershell"],
+  "subcommands": [
+    { "name": "init", "description": "Create a new package.json", "options": [{ "name": "--yes", "short": "-y", "description": "Accept defaults" }], "examples": ["yarn init", "yarn init -y"] },
+    { "name": "add", "description": "Add a package", "args": [{ "name": "<package>", "type": "string", "required": true, "description": "Package name" }], "options": [{ "name": "--dev", "short": "-D", "description": "Add to devDependencies" }, { "name": "--peer", "short": "-P", "description": "Add to peerDependencies" }, { "name": "--exact", "short": "-E", "description": "Add exact version" }], "examples": ["yarn add react", "yarn add -D typescript", "yarn add react@^18.0.0"] },
+    { "name": "remove", "description": "Remove a package", "args": [{ "name": "<package>", "type": "string", "required": true, "description": "Package name" }], "examples": ["yarn remove lodash"] },
+    { "name": "install", "description": "Install all dependencies", "options": [{ "name": "--frozen-lockfile", "description": "Don't generate lockfile changes" }, { "name": "--production", "description": "Only install production dependencies" }], "examples": ["yarn install", "yarn install --frozen-lockfile"] },
+    { "name": "run", "description": "Run a script from package.json", "args": [{ "name": "<script>", "type": "string", "required": true, "description": "Script name" }], "examples": ["yarn run build", "yarn run dev"] },
+    { "name": "upgrade", "description": "Upgrade packages", "args": [{ "name": "<package>", "type": "string", "required": false, "description": "Package name" }], "options": [{ "name": "--latest", "description": "Upgrade to latest version" }], "examples": ["yarn upgrade", "yarn upgrade --latest"] },
+    { "name": "outdated", "description": "Check for outdated packages", "examples": ["yarn outdated"] },
+    { "name": "cache clean", "description": "Clean cache", "examples": ["yarn cache clean"] },
+    { "name": "link", "description": "Symlink a local package", "args": [{ "name": "<package>", "type": "string", "required": false, "description": "Package name" }], "examples": ["yarn link", "yarn link my-package"] },
+    { "name": "dlx", "description": "Run a package without installing (Yarn Berry)", "args": [{ "name": "<command>", "type": "string", "required": true, "description": "Command to run" }], "examples": ["yarn dlx create-react-app myapp"] },
+    { "name": "workspace", "description": "Run command in workspace", "examples": ["yarn workspace @myapp/server add express"] },
+    { "name": "workspaces foreach", "description": "Run command in all workspaces", "examples": ["yarn workspaces foreach run build"] }
+  ],
+  "globalOptions": [
+    { "name": "--help", "short": "-h", "description": "Show help" },
+    { "name": "--version", "short": "-v", "description": "Show version" },
+    { "name": "--verbose", "description": "Verbose output" }
+  ],
+  "examples": ["yarn add react react-dom", "yarn install --frozen-lockfile", "yarn run build"],
+  "relatedCommands": ["npm", "pnpm", "npx", "node"]
+}

package/data/commands/yum.json

@@ -0,0 +1,98 @@
+{
+  "name": "yum",
+  "description": "Package manager for RHEL/CentOS (legacy, replaced by dnf)",
+  "category": "Package Managers",
+  "platforms": ["linux"],
+  "shells": ["bash", "zsh", "fish"],
+  "subcommands": [
+    { "name": "install", "description": "Install packages", "args": [{ "name": "packages", "description": "Package names", "required": true }], "options": [
+      { "name": "-y", "description": "Assume yes" },
+      { "name": "--enablerepo", "description": "Enable repository", "takesValue": true },
+      { "name": "--disablerepo", "description": "Disable repository", "takesValue": true }
+    ]},
+    { "name": "update", "description": "Update packages", "args": [{ "name": "packages", "description": "Specific packages (optional)", "required": false }] },
+    { "name": "remove", "description": "Remove packages", "args": [{ "name": "packages", "description": "Package names", "required": true }] },
+    { "name": "erase", "description": "Alias for remove" },
+    { "name": "list", "description": "List packages", "options": [
+      { "name": "installed", "description": "Only installed" },
+      { "name": "available", "description": "Only available" },
+      { "name": "updates", "description": "Only updates" }
+    ]},
+    { "name": "search", "description": "Search packages", "args": [{ "name": "query", "description": "Search term", "required": true }] },
+    { "name": "info", "description": "Show package information", "args": [{ "name": "package", "description": "Package name", "required": true }] },
+    { "name": "provides", "description": "Find package providing a file", "args": [{ "name": "file", "description": "File path or glob", "required": true }] },
+    { "name": "check-update", "description": "Check for available updates" },
+    { "name": "upgrade", "description": "Upgrade all packages" },
+    { "name": "downgrade", "description": "Downgrade a package" },
+    { "name": "reinstall", "description": "Reinstall a package" },
+    { "name": "clean", "description": "Clean caches", "subcommands": [
+      { "name": "all", "description": "Clean all caches" },
+      { "name": "metadata", "description": "Clean metadata" },
+      { "name": "packages", "description": "Clean packages" },
+      { "name": "dbcache", "description": "Clean dbcache" },
+      { "name": "expire-cache", "description": "Expire cache" }
+    ]},
+    { "name": "makecache", "description": "Generate metadata cache" },
+    { "name": "groupinstall", "description": "Install a group", "args": [{ "name": "group", "description": "Group name", "required": true }] },
+    { "name": "grouplist", "description": "List groups" },
+    { "name": "groupinfo", "description": "Group details" },
+    { "name": "repolist", "description": "List repositories" },
+    { "name": "repoinfo", "description": "Repository details" },
+    { "name": "deplist", "description": "List dependencies" },
+    { "name": "history", "description": "Transaction history" },
+    { "name": "localinstall", "description": "Install local RPM" }
+  ],
+  "globalOptions": [
+    { "name": "-y", "description": "Assume yes" },
+    { "name": "-q", "description": "Quiet" },
+    { "name": "-v", "description": "Verbose" },
+    { "name": "--enablerepo", "description": "Enable repo", "takesValue": true },
+    { "name": "--disablerepo", "description": "Disable repo", "takesValue": true },
+    { "name": "--nogpgcheck", "description": "Skip GPG checks" },
+    { "name": "--skip-broken", "description": "Skip broken packages" },
+    { "name": "-C", "description": "Use cache only" },
+    { "name": "--downloadonly", "description": "Download without installing" },
+    { "name": "--setopt", "description": "Set config option", "takesValue": true }
+  ],
+  "examples": [
+    { "command": "sudo yum install nginx", "description": "Install nginx" },
+    { "command": "sudo yum install -y git curl wget", "description": "Install with auto-yes" },
+    { "command": "sudo yum update", "description": "Update all packages" },
+    { "command": "sudo yum remove httpd", "description": "Remove package" },
+    { "command": "yum search redis", "description": "Search packages" },
+    { "command": "yum info nginx", "description": "Package details" },
+    { "command": "yum list installed", "description": "List installed" },
+    { "command": "yum check-update", "description": "Check for updates" },
+    { "command": "yum repolist", "description": "List enabled repos" },
+    { "command": "sudo yum clean all", "description": "Clean all caches" }
+  ],
+  "relatedCommands": ["dnf", "rpm"],
+  "contextEngine": {
+    "detectors": [
+      {
+        "name": "installed",
+        "description": "Installed packages",
+        "command": "yum list installed 2>/dev/null | tail -20",
+        "parser": "lines",
+        "cacheFor": 120,
+        "requiresCmd": "yum"
+      },
+      {
+        "name": "repos",
+        "description": "Configured repositories",
+        "command": "yum repolist 2>/dev/null | tail -10",
+        "parser": "lines",
+        "cacheFor": 300,
+        "requiresCmd": "yum"
+      },
+      {
+        "name": "updates",
+        "description": "Available updates",
+        "command": "yum check-update 2>/dev/null | tail -15",
+        "parser": "lines",
+        "cacheFor": 300,
+        "requiresCmd": "yum"
+      }
+    ]
+  }
+}

package/data/commands/zip.json

@@ -0,0 +1,59 @@
+{
+  "name": "zip",
+  "description": "Package and compress files into ZIP archives",
+  "category": "Linux Coreutils",
+  "platforms": ["linux", "macos", "windows"],
+  "shells": ["bash", "zsh", "powershell", "fish"],
+  "subcommands": [],
+  "globalOptions": [
+    { "name": "-r", "description": "Recurse into directories" },
+    { "name": "-e", "description": "Encrypt with password" },
+    { "name": "-P", "description": "Password (visible in process list!)", "takesValue": true },
+    { "name": "-j", "description": "Junk directory names (store files only)" },
+    { "name": "-9", "description": "Maximum compression" },
+    { "name": "-0", "description": "No compression (store only)" },
+    { "name": "-u", "description": "Update existing entries" },
+    { "name": "-d", "description": "Delete entries from archive" },
+    { "name": "-f", "description": "Freshen (update only changed files)" },
+    { "name": "-m", "description": "Move files into archive (delete originals)" },
+    { "name": "-x", "description": "Exclude files matching pattern", "takesValue": true },
+    { "name": "-i", "description": "Include only files matching pattern", "takesValue": true },
+    { "name": "-q", "description": "Quiet mode" },
+    { "name": "-v", "description": "Verbose mode" },
+    { "name": "-T", "description": "Test archive integrity" },
+    { "name": "-s", "description": "Split size for split archives", "takesValue": true },
+    { "name": "-l", "description": "Convert LF to CRLF" },
+    { "name": "-ll", "description": "Convert CRLF to LF" },
+    { "name": "-y", "description": "Store symbolic links" },
+    { "name": "--symlinks", "description": "Store symbolic links" }
+  ],
+  "examples": [
+    { "command": "zip archive.zip file1.txt file2.txt", "description": "Zip files" },
+    { "command": "zip -r project.zip src/", "description": "Zip directory recursively" },
+    { "command": "zip -r app.zip . -x '*.git*' -x 'node_modules/*'", "description": "Zip excluding patterns" },
+    { "command": "zip -9 -r compressed.zip dir/", "description": "Maximum compression" },
+    { "command": "zip -e secure.zip secret.txt", "description": "Encrypt zip" },
+    { "command": "zip -d archive.zip unwanted.txt", "description": "Delete from archive" },
+    { "command": "zip -u archive.zip updated.txt", "description": "Update file in archive" },
+    { "command": "zip -j flat.zip dir/a.txt dir/b.txt", "description": "Flatten directory structure" }
+  ],
+  "relatedCommands": ["unzip", "tar"],
+  "contextEngine": {
+    "detectors": [
+      {
+        "name": "zip_files",
+        "description": "Existing ZIP archives",
+        "command": "find . -maxdepth 2 -name '*.zip' 2>/dev/null | head -10",
+        "parser": "lines",
+        "cacheFor": 15
+      },
+      {
+        "name": "current_files",
+        "description": "Files in current directory",
+        "command": "ls -1 2>/dev/null | head -30",
+        "parser": "lines",
+        "cacheFor": 10
+      }
+    ]
+  }
+}

package/index.d.ts

@@ -0,0 +1,131 @@
+export interface CommandArg {
+  name: string;
+  description?: string;
+  required?: boolean;
+  type?: string;
+}
+
+export interface CommandOption {
+  name: string;
+  shorthand?: string;
+  short?: string;
+  description?: string;
+  takesValue?: boolean;
+  type?: string;
+}
+
+export interface CommandExample {
+  command: string;
+  description?: string;
+}
+
+export interface Subcommand {
+  name: string;
+  description?: string;
+  args?: CommandArg[];
+  options?: CommandOption[];
+  subcommands?: Subcommand[];
+  examples?: string[] | CommandExample[];
+}
+
+export interface ContextDetector {
+  name: string;
+  description?: string;
+  command: string;
+  parser: "text" | "lines" | "json" | "csv" | "keyvalue" | "regex" | "table";
+  pattern?: string;
+  cacheFor?: number;
+  requiresCmd?: string;
+}
+
+export interface ContextEngine {
+  detectors: ContextDetector[];
+}
+
+export interface Command {
+  name: string;
+  description: string;
+  category: string;
+  platforms: ("linux" | "macos" | "windows")[];
+  shells: ("bash" | "zsh" | "fish" | "powershell" | "cmd")[];
+  subcommands: Subcommand[];
+  globalOptions: CommandOption[];
+  examples: CommandExample[];
+  relatedCommands?: string[];
+  contextEngine?: ContextEngine;
+}
+
+/**
+ * Get a single command by name.
+ */
+export function getCommand(name: string): Command | undefined;
+
+/**
+ * Get all commands as an array.
+ */
+export function getAllCommands(): Command[];
+
+/**
+ * List all available command names (sorted).
+ */
+export function listCommandNames(): string[];
+
+/**
+ * Get commands filtered by category (case-insensitive partial match).
+ */
+export function getCommandsByCategory(category: string): Command[];
+
+/**
+ * Get commands filtered by platform.
+ */
+export function getCommandsByPlatform(platform: "linux" | "macos" | "windows"): Command[];
+
+/**
+ * Search commands by name, description, or category.
+ */
+export function searchCommands(query: string): Command[];
+
+/**
+ * Get all unique categories.
+ */
+export function getCategories(): string[];
+
+/**
+ * Get the context engine detectors for a command.
+ */
+export function getContextEngine(name: string): ContextEngine | null;
+
+/**
+ * Get subcommands for a command.
+ */
+export function getSubcommands(name: string): Subcommand[];
+
+/**
+ * Get global options for a command.
+ */
+export function getGlobalOptions(name: string): CommandOption[];
+
+/**
+ * Get examples for a command.
+ */
+export function getExamples(name: string): CommandExample[];
+
+/**
+ * Get the total number of commands.
+ */
+export function count(): number;
+
+/**
+ * Clear the internal cache.
+ */
+export function clearCache(): void;
+
+/**
+ * Resolve the absolute path to a command JSON file.
+ */
+export function resolveCommandPath(name: string): string;
+
+/**
+ * Absolute path to the commands data directory.
+ */
+export const dataDir: string;

package/index.js

@@ -0,0 +1,189 @@
+"use strict";
+
+const fs = require("fs");
+const path = require("path");
+
+const COMMANDS_DIR = path.join(__dirname, "data", "commands");
+
+/** @type {Map<string, object>|null} */
+let _cache = null;
+
+/**
+ * Load all commands into cache (lazy, first call only).
+ * @returns {Map<string, object>}
+ */
+function _loadAll() {
+  if (_cache) return _cache;
+  _cache = new Map();
+  const files = fs.readdirSync(COMMANDS_DIR).filter((f) => f.endsWith(".json"));
+  for (const file of files) {
+    const data = JSON.parse(
+      fs.readFileSync(path.join(COMMANDS_DIR, file), "utf-8")
+    );
+    _cache.set(data.name, data);
+  }
+  return _cache;
+}
+
+/**
+ * Get a single command by name.
+ * @param {string} name - Command name (e.g. "git", "docker", "kubectl")
+ * @returns {object|undefined}
+ */
+function getCommand(name) {
+  return _loadAll().get(name);
+}
+
+/**
+ * Get all commands as an array.
+ * @returns {object[]}
+ */
+function getAllCommands() {
+  return Array.from(_loadAll().values());
+}
+
+/**
+ * List all available command names.
+ * @returns {string[]}
+ */
+function listCommandNames() {
+  return Array.from(_loadAll().keys()).sort();
+}
+
+/**
+ * Get commands filtered by category.
+ * @param {string} category - Category name (case-insensitive partial match)
+ * @returns {object[]}
+ */
+function getCommandsByCategory(category) {
+  const lc = category.toLowerCase();
+  return getAllCommands().filter(
+    (cmd) => cmd.category && cmd.category.toLowerCase().includes(lc)
+  );
+}
+
+/**
+ * Get commands filtered by platform.
+ * @param {string} platform - "linux" | "macos" | "windows"
+ * @returns {object[]}
+ */
+function getCommandsByPlatform(platform) {
+  const lc = platform.toLowerCase();
+  return getAllCommands().filter(
+    (cmd) =>
+      Array.isArray(cmd.platforms) &&
+      cmd.platforms.some((p) => p.toLowerCase() === lc)
+  );
+}
+
+/**
+ * Search commands by name, description, or category.
+ * @param {string} query - Search query (case-insensitive)
+ * @returns {object[]}
+ */
+function searchCommands(query) {
+  const lc = query.toLowerCase();
+  return getAllCommands().filter(
+    (cmd) =>
+      cmd.name.toLowerCase().includes(lc) ||
+      (cmd.description && cmd.description.toLowerCase().includes(lc)) ||
+      (cmd.category && cmd.category.toLowerCase().includes(lc))
+  );
+}
+
+/**
+ * Get all unique categories.
+ * @returns {string[]}
+ */
+function getCategories() {
+  const cats = new Set();
+  for (const cmd of _loadAll().values()) {
+    if (cmd.category) cats.add(cmd.category);
+  }
+  return Array.from(cats).sort();
+}
+
+/**
+ * Get the context engine detectors for a command.
+ * @param {string} name - Command name
+ * @returns {object|null} The contextEngine config or null
+ */
+function getContextEngine(name) {
+  const cmd = getCommand(name);
+  return cmd && cmd.contextEngine ? cmd.contextEngine : null;
+}
+
+/**
+ * Get subcommands for a command.
+ * @param {string} name - Command name
+ * @returns {object[]}
+ */
+function getSubcommands(name) {
+  const cmd = getCommand(name);
+  return cmd && Array.isArray(cmd.subcommands) ? cmd.subcommands : [];
+}
+
+/**
+ * Get global options for a command.
+ * @param {string} name - Command name
+ * @returns {object[]}
+ */
+function getGlobalOptions(name) {
+  const cmd = getCommand(name);
+  return cmd && Array.isArray(cmd.globalOptions) ? cmd.globalOptions : [];
+}
+
+/**
+ * Get examples for a command.
+ * @param {string} name - Command name
+ * @returns {object[]}
+ */
+function getExamples(name) {
+  const cmd = getCommand(name);
+  return cmd && Array.isArray(cmd.examples) ? cmd.examples : [];
+}
+
+/**
+ * Get the total number of commands available.
+ * @returns {number}
+ */
+function count() {
+  return _loadAll().size;
+}
+
+/**
+ * Clear the internal cache (useful for testing).
+ */
+function clearCache() {
+  _cache = null;
+}
+
+/**
+ * Resolve the path to a specific command JSON file.
+ * @param {string} name - Command name
+ * @returns {string}
+ */
+function resolveCommandPath(name) {
+  return path.join(COMMANDS_DIR, `${name}.json`);
+}
+
+/** @type {string} Path to the commands data directory */
+const dataDir = COMMANDS_DIR;
+
+module.exports = {
+  getCommand,
+  getAllCommands,
+  listCommandNames,
+  getCommandsByCategory,
+  getCommandsByPlatform,
+  searchCommands,
+  getCategories,
+  getContextEngine,
+  getSubcommands,
+  getGlobalOptions,
+  getExamples,
+  count,
+  clearCache,
+  resolveCommandPath,
+  dataDir,
+};

package/index.mjs

@@ -0,0 +1,21 @@
+import { createRequire } from "module";
+const require = createRequire(import.meta.url);
+const engine = require("./index.js");
+
+export const getCommand = engine.getCommand;
+export const getAllCommands = engine.getAllCommands;
+export const listCommandNames = engine.listCommandNames;
+export const getCommandsByCategory = engine.getCommandsByCategory;
+export const getCommandsByPlatform = engine.getCommandsByPlatform;
+export const searchCommands = engine.searchCommands;
+export const getCategories = engine.getCategories;
+export const getContextEngine = engine.getContextEngine;
+export const getSubcommands = engine.getSubcommands;
+export const getGlobalOptions = engine.getGlobalOptions;
+export const getExamples = engine.getExamples;
+export const count = engine.count;
+export const clearCache = engine.clearCache;
+export const resolveCommandPath = engine.resolveCommandPath;
+export const dataDir = engine.dataDir;
+
+export default engine;

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "@enjoys/context-engine",
+  "version": "1.0.0",
+  "description": "Comprehensive CLI command context engine with 133 tools — subcommands, options, examples, and runtime context detectors for intelligent terminal autocomplete",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "exports": {
+    ".": {
+      "require": "./index.js",
+      "import": "./index.mjs",
+      "types": "./index.d.ts"
+    },
+    "./commands": "./data/commands",
+    "./commands/*": "./data/commands/*"
+  },
+  "files": [
+    "index.js",
+    "index.mjs",
+    "index.d.ts",
+    "data/"
+  ],
+  "scripts": {
+    "test": "node test.js",
+    "prepublishOnly": "node -e \"require('./index.js')\""
+  },
+  "keywords": [
+    "cli",
+    "terminal",
+    "autocomplete",
+    "context-engine",
+    "command-palette",
+    "shell",
+    "bash",
+    "zsh",
+    "devtools",
+    "docker",
+    "git",
+    "kubectl",
+    "terraform",
+    "aws",
+    "npm",
+    "node",
+    "python",
+    "go",
+    "rust",
+    "completions",
+    "subcommands",
+    "options",
+    "webterminal"
+  ],
+  "author": "Enjoys Inc",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/enjoys-in/context-engine.git"
+  },
+  "homepage": "https://github.com/enjoys-in/context-engine#readme",
+  "bugs": {
+    "url": "https://github.com/enjoys-in/context-engine/issues"
+  },
+  "engines": {
+    "node": ">=14.0.0"
+  }
+}