@kubernetesjs/cli 0.0.3 → 0.1.1

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2022 Dan Lynch <pyramation@gmail.com>
+Copyright (c) 2024 Dan Lynch <pyramation@gmail.com>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,65 +1,163 @@
-# KubernetesJS
+# @kubernetesjs/cli
 
-KubernetesJS is a **fully-typed**, zero-dependency TypeScript library designed to simplify interactions with Kubernetes APIs. With comprehensive TypeScript support, it provides a strongly-typed interface that makes managing Kubernetes resources clear and predictable, ideal for TypeScript developers looking to integrate Kubernetes management into their applications.
+<p align="center">
+  <img src="https://user-images.githubusercontent.com/545047/188804067-28e67e5e-0214-4449-ab04-2e0c564a6885.svg" width="80"><br />
+    KubernetesJS CLI
+</p>
 
-## Features
-
-- **🔒 Fully Typed**: Complete TypeScript definitions for all functions and models for an enhanced development experience.
-- **🚀 Zero Dependencies**: Works out of the box without the need for additional installations.
-- **📡 Full Kubernetes API Coverage**: Supports all Kubernetes API endpoints with detailed TypeScript types.
-- **🌐 Cross-Platform**: Works with both Node.js and browser environments.
+A command-line interface for interacting with Kubernetes clusters, built with TypeScript.
 
 ## Installation
 
-To install KubernetesJS, you can use npm or yarn:
+```sh
+npm install -g @kubernetesjs/cli
+```
+
+## Usage
+
+The CLI provides several commands for managing Kubernetes resources. You can use either `k8s` or `kubernetes` as the command prefix:
 
-```bash
-npm install kubernetesjs
+```sh
+k8s <command> [options]
 # or
-yarn add kubernetesjs
-
-```
-
-## Example (WIP)
-
-```js
-import { KubernetesClient } from "kubernetesjs";
-
-const client = new KubernetesClient({
-  restEndpoint: 'http://127.0.0.1:8001'
-});
-
-client.listCoreV1NamespacedPod({
-  path: {
-    namespace: 'default'
-  },
-  query: {
-    // Add any necessary query parameters here
-  }
-}).then(result => {
-  if (result.items && result.items.length) {
-    result.items.forEach(item => {
-      console.log('NODE:', item.spec.nodeName);
-
-      const initContainers = item.status.initContainerStatuses?.map(ic => ({
-        image: ic.image,
-        name: ic.name,
-        ready: ic.ready,
-        state: ic.state
-      }));
-
-      const containers = item.status.containerStatuses?.map(c => ({
-        image: c.image,
-        name: c.name,
-        ready: c.ready,
-        state: c.state
-      }));
-
-      console.log({ containers });
-      console.log({ initContainers });
-    });
-  }
-}).catch(reason => {
-  console.error('Failed to fetch pods:', reason);
-});
+kubernetes <command> [options]
+```
+
+Options:
+-  `--client-url`: Kubernetes API server URL (default: http://localhost:8001)
+
+
+### Available Commands
+
+#### Get
+Retrieve information about Kubernetes resources.
+
+```sh
+k8s get <resource> [options]
+```
+
+#### Apply
+Apply configurations to your Kubernetes cluster.
+
+```sh
+k8s apply -f <file> [options]
+```
+
+#### Delete
+Delete resources from your Kubernetes cluster.
+
+```sh
+k8s delete <resource> <name> [options]
+```
+
+#### Describe
+Show detailed information about a specific resource.
+
+```sh
+k8s describe <resource> <name> [options]
+```
+
+#### Logs
+View logs from pods.
+
+```sh
+k8s logs <pod-name> [options]
+```
+
+#### Port Forward
+Forward ports from pods to your local machine.
+
+```sh
+k8s port-forward <pod-name> <local-port>:<pod-port> [options]
+```
+
+#### Exec
+Execute commands in a container.
+
+```sh
+k8s exec <pod-name> -- <command> [options]
+```
+
+#### Cluster Info
+Display information about the current cluster.
+
+```sh
+k8s cluster-info
+```
+
+#### Config
+Manage Kubernetes configuration.
+
+```sh
+k8s config [options]
+```
+
+## Examples
+
+### Get Pod Information
+
+```sh
+k8s get pods
+```
+
+### Apply a Configuration File
+
+```sh
+k8s apply -f deployment.yaml
+```
+
+### View Pod Logs
+
+```sh
+k8s logs my-pod
+```
+
+### Port Forward to a Service
+
+```sh
+k8s port-forward my-pod 8080:80
+```
+
+## Configuration
+
+The CLI uses the default Kubernetes configuration from `~/.kube/config`. You can specify a different configuration file using the `--kubeconfig` option.
+
+## Development
+
+When first cloning the repo:
+
+```sh
+yarn
+# Build the production packages
+yarn build
+```
+
+For development with source maps:
+
+```sh
+yarn
+# Build with source maps for better debugging
+yarn build:dev
 ```
+
+## Related
+
+Checkout these related projects:
+
+* [`schema-typescript`](https://github.com/hyperweb-io/schema-typescript/tree/main/packages/schema-typescript)  
+  Provides robust tools for handling JSON schemas and converting them to TypeScript interfaces with ease and efficiency.
+* [`@schema-typescript/cli`](https://github.com/hyperweb-io/schema-typescript/tree/main/packages/cli)  
+  CLI is the command line utility for `schema-typescript`.
+* [`schema-sdk`](https://github.com/hyperweb-io/schema-typescript/tree/main/packages/schema-sdk)  
+  Provides robust tools for handling OpenAPI schemas and converting them to TypeScript clients with ease and efficiency.
+* [`starship`](https://github.com/hyperweb-io/starship) Unified Testing and Development for the Interchain.
+
+## Credits
+
+🛠 Built by Hyperweb — if you like our tools, please checkout and contribute to [our github ⚛️](https://github.com/hyperweb-io)
+
+## Disclaimer
+
+AS DESCRIBED IN THE LICENSES, THE SOFTWARE IS PROVIDED “AS IS”, AT YOUR OWN RISK, AND WITHOUT WARRANTIES OF ANY KIND.
+
+No developer or entity involved in creating this software will be liable for any claims or damages whatsoever associated with your use, inability to use, or your interaction with other users of the code, including any direct, indirect, incidental, special, exemplary, punitive or consequential damages, or loss of profits, cryptocurrencies, tokens, or anything else of value.

package/commands/apply.d.ts

@@ -0,0 +1,4 @@
+import { CLIOptions, Inquirerer } from 'inquirerer';
+import { ParsedArgs } from 'minimist';
+declare const _default: (argv: Partial<ParsedArgs>, prompter: Inquirerer, _options: CLIOptions) => Promise<void>;
+export default _default;

package/commands/apply.js

@@ -0,0 +1,171 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const chalk_1 = __importDefault(require("chalk"));
+const kubernetesjs_1 = require("kubernetesjs");
+const config_1 = require("../config");
+const fs = __importStar(require("fs"));
+async function promptYamlFilePath(prompter, argv) {
+    const question = {
+        type: 'text',
+        name: 'filePath',
+        message: 'Enter path to YAML file',
+        required: true
+    };
+    const { filePath } = await prompter.prompt(argv, [question]);
+    return filePath;
+}
+async function applyResource(client, resource, namespace) {
+    const kind = resource.kind.toLowerCase();
+    const name = resource.metadata?.name;
+    if (!name) {
+        throw new Error('Resource must have a name');
+    }
+    console.log(chalk_1.default.blue(`Applying ${kind} "${name}" in namespace ${namespace}...`));
+    try {
+        switch (kind) {
+            case 'deployment':
+                await client.createAppsV1NamespacedDeployment({
+                    path: { namespace },
+                    query: {
+                        pretty: 'true',
+                        fieldManager: 'kubernetesjs-cli'
+                    },
+                    body: resource
+                });
+                console.log(chalk_1.default.green(`Deployment "${name}" created/updated successfully`));
+                break;
+            case 'service':
+                await client.createCoreV1NamespacedService({
+                    path: { namespace },
+                    query: {
+                        pretty: 'true',
+                        fieldManager: 'kubernetesjs-cli'
+                    },
+                    body: resource
+                });
+                console.log(chalk_1.default.green(`Service "${name}" created/updated successfully`));
+                break;
+            case 'pod':
+                await client.createCoreV1NamespacedPod({
+                    path: { namespace },
+                    query: {
+                        pretty: 'true',
+                        fieldManager: 'kubernetesjs-cli'
+                    },
+                    body: resource
+                });
+                console.log(chalk_1.default.green(`Pod "${name}" created/updated successfully`));
+                break;
+            case 'configmap':
+                await client.createCoreV1NamespacedConfigMap({
+                    path: { namespace },
+                    query: {
+                        pretty: 'true',
+                        fieldManager: 'kubernetesjs-cli'
+                    },
+                    body: resource
+                });
+                console.log(chalk_1.default.green(`ConfigMap "${name}" created/updated successfully`));
+                break;
+            case 'secret':
+                await client.createCoreV1NamespacedSecret({
+                    path: { namespace },
+                    query: {
+                        pretty: 'true',
+                        fieldManager: 'kubernetesjs-cli'
+                    },
+                    body: resource
+                });
+                console.log(chalk_1.default.green(`Secret "${name}" created/updated successfully`));
+                break;
+            default:
+                console.log(chalk_1.default.yellow(`Resource kind "${kind}" not implemented yet`));
+        }
+    }
+    catch (error) {
+        console.error(chalk_1.default.red(`Error applying ${kind} "${name}": ${error}`));
+        throw error;
+    }
+}
+exports.default = async (argv, prompter, _options) => {
+    try {
+        const client = new kubernetesjs_1.KubernetesClient({
+            restEndpoint: argv.clientUrl
+        });
+        const filePath = argv.f || argv._?.[0] || await promptYamlFilePath(prompter, argv);
+        if (!filePath) {
+            console.error(chalk_1.default.red('No file path provided'));
+            return;
+        }
+        if (!fs.existsSync(filePath)) {
+            console.error(chalk_1.default.red(`File not found: ${filePath}`));
+            return;
+        }
+        let resources;
+        try {
+            const content = (0, config_1.readYamlFile)(filePath);
+            if (Array.isArray(content)) {
+                resources = content;
+            }
+            else if (content.kind === 'List' && Array.isArray(content.items)) {
+                resources = content.items;
+            }
+            else {
+                resources = [content];
+            }
+        }
+        catch (error) {
+            console.error(chalk_1.default.red(`Error parsing YAML file: ${error}`));
+            return;
+        }
+        for (const resource of resources) {
+            try {
+                const namespace = resource.metadata?.namespace || argv.n || argv.namespace || 'default';
+                await applyResource(client, resource, namespace);
+            }
+            catch (error) {
+                console.error(chalk_1.default.red(`Failed to apply resource: ${error}`));
+            }
+        }
+        console.log(chalk_1.default.green('Apply completed'));
+    }
+    catch (error) {
+        console.error(chalk_1.default.red(`Error: ${error}`));
+    }
+};

package/commands/cluster-info.d.ts

@@ -0,0 +1,4 @@
+import { CLIOptions, Inquirerer } from 'inquirerer';
+import { ParsedArgs } from 'minimist';
+declare const _default: (_argv: Partial<ParsedArgs>, _prompter: Inquirerer, _options: CLIOptions) => Promise<void>;
+export default _default;

package/commands/cluster-info.js

@@ -0,0 +1,26 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const chalk_1 = __importDefault(require("chalk"));
+const kubernetesjs_1 = require("kubernetesjs");
+exports.default = async (_argv, _prompter, _options) => {
+    try {
+        const client = new kubernetesjs_1.KubernetesClient({
+            restEndpoint: _argv.clientUrl
+        });
+        console.log(chalk_1.default.blue('Kubernetes cluster info:'));
+        const apiVersions = await client.getAPIVersions({
+            params: {},
+            query: {}
+        });
+        console.log(chalk_1.default.bold('\nAPI Versions:'));
+        if (apiVersions.apiVersion) {
+            console.log(apiVersions.apiVersion);
+        }
+    }
+    catch (error) {
+        console.error(chalk_1.default.red(`Error: ${error}`));
+    }
+};

package/commands/config-handler.d.ts

@@ -0,0 +1,11 @@
+import { CLIOptions, Inquirerer } from 'inquirerer';
+import { ParsedArgs } from 'minimist';
+/**
+ * Handle the --config flag by parsing the YAML file and executing the appropriate command
+ * @param argv Command line arguments
+ * @param prompter Inquirerer instance
+ * @param options CLI options
+ * @param commandMap Map of available commands
+ */
+declare const _default: (argv: Partial<ParsedArgs>, prompter: Inquirerer, options: CLIOptions, commandMap: Record<string, Function>) => Promise<boolean>;
+export default _default;

package/commands/config-handler.js

@@ -0,0 +1,81 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const chalk_1 = __importDefault(require("chalk"));
+const fs = __importStar(require("fs"));
+const config_1 = require("../config");
+/**
+ * Handle the --config flag by parsing the YAML file and executing the appropriate command
+ * @param argv Command line arguments
+ * @param prompter Inquirerer instance
+ * @param options CLI options
+ * @param commandMap Map of available commands
+ */
+exports.default = async (argv, prompter, options, commandMap) => {
+    if (!argv.config) {
+        return false;
+    }
+    const configPath = argv.config;
+    if (!fs.existsSync(configPath)) {
+        console.error(chalk_1.default.red(`Config file not found: ${configPath}`));
+        return true;
+    }
+    try {
+        const resource = (0, config_1.readYamlFile)(configPath);
+        const resourceType = (0, config_1.inferResourceType)(resource);
+        console.log(chalk_1.default.blue(`Detected resource type: ${resourceType}`));
+        let command;
+        command = 'apply';
+        const newArgv = {
+            ...argv,
+            _: [configPath],
+            f: configPath
+        };
+        if (commandMap[command]) {
+            await commandMap[command](newArgv, prompter, options);
+        }
+        else {
+            console.error(chalk_1.default.red(`No command found for resource type: ${resourceType}`));
+        }
+        return true;
+    }
+    catch (error) {
+        console.error(chalk_1.default.red(`Error processing config file: ${error}`));
+        return true;
+    }
+};

package/commands/config.d.ts

@@ -0,0 +1,4 @@
+import { CLIOptions, Inquirerer } from 'inquirerer';
+import { ParsedArgs } from 'minimist';
+declare const _default: (argv: Partial<ParsedArgs>, prompter: Inquirerer, _options: CLIOptions) => Promise<void>;
+export default _default;

package/commands/config.js

@@ -0,0 +1,72 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const chalk_1 = __importDefault(require("chalk"));
+const kubernetesjs_1 = require("kubernetesjs");
+const config_1 = require("../config");
+async function promptNamespace(prompter, argv, client) {
+    try {
+        const namespaces = await client.listCoreV1Namespace({
+            query: {}
+        });
+        if (!namespaces.items || namespaces.items.length === 0) {
+            console.log(chalk_1.default.yellow('No namespaces found'));
+            return '';
+        }
+        const options = namespaces.items.map(ns => ({
+            name: ns.metadata.name,
+            value: ns.metadata.name
+        }));
+        const question = {
+            type: 'autocomplete',
+            name: 'namespace',
+            message: 'Select namespace',
+            options,
+            maxDisplayLines: 10,
+            required: true
+        };
+        const { namespace } = await prompter.prompt(argv, [question]);
+        return namespace;
+    }
+    catch (error) {
+        console.error(chalk_1.default.red(`Error getting namespaces: ${error}`));
+        return '';
+    }
+}
+exports.default = async (argv, prompter, _options) => {
+    try {
+        const client = new kubernetesjs_1.KubernetesClient({
+            restEndpoint: argv.clientUrl
+        });
+        const subcommand = argv._?.[0];
+        if (subcommand === 'get-context') {
+            const namespace = (0, config_1.getCurrentNamespace)();
+            console.log(chalk_1.default.green(`Current namespace: ${namespace}`));
+            return;
+        }
+        if (subcommand === 'set-context') {
+            if (argv.current !== true) {
+                console.error(chalk_1.default.red('Missing --current flag'));
+                return;
+            }
+            let namespace = argv.namespace;
+            if (!namespace) {
+                namespace = await promptNamespace(prompter, argv, client);
+                if (!namespace) {
+                    return;
+                }
+            }
+            (0, config_1.setCurrentNamespace)(namespace);
+            console.log(chalk_1.default.green(`Namespace set to "${namespace}"`));
+            return;
+        }
+        console.log(chalk_1.default.blue('Available config commands:'));
+        console.log('  get-context                  Display the current context');
+        console.log('  set-context --current --namespace=<namespace>  Set the current namespace');
+    }
+    catch (error) {
+        console.error(chalk_1.default.red(`Error: ${error}`));
+    }
+};

package/commands/delete.d.ts

@@ -0,0 +1,4 @@
+import { CLIOptions, Inquirerer } from 'inquirerer';
+import { ParsedArgs } from 'minimist';
+declare const _default: (argv: Partial<ParsedArgs>, prompter: Inquirerer, _options: CLIOptions) => Promise<void>;
+export default _default;