kubefc 0.1.0

package/README.md

@@ -0,0 +1,320 @@
+# KFC (Kubernetes Follow Colorful)
+
+<img src="assets/logo.png" width="200" alt="KFC Logo">
+
+A beautiful CLI tool for following Kubernetes deployment logs with rich syntax highlighting and interactive UI, built with **TypeScript + Ink**.
+
+![Version](https://img.shields.io/badge/version-0.1.0-blue)
+![License](https://img.shields.io/badge/license-MIT-green)
+![Node](https://img.shields.io/badge/node-%3E%3D14-brightgreen)
+
+---
+
+## ✨ Features
+
+- 🎨 **Rich Syntax Highlighting** - JSON, strings, numbers, booleans, URLs, IPs, and more
+- 🔄 **Auto-Reconnect** - Automatically reconnects when connection is lost
+- 🎯 **Interactive Selection** - Beautiful Ink-powered deployment selector
+- 📊 **Real-time Status** - Live connection status indicator
+- 🚀 **Fast & Lightweight** - Built with TypeScript for performance
+- 🎭 **React for CLI** - Powered by Ink (React for terminal)
+- 🌍 **Cross-platform** - Works on Windows, macOS, and Linux
+- 📦 **Zero Config** - Works out of the box with kubectl
+
+---
+
+## 🚀 Quick Start
+
+### Using npx (Recommended)
+
+```bash
+npx @logan/kfc -n production my-deployment
+```
+
+### Global Installation
+
+```bash
+npm install -g @logan/kfc
+kfc --help
+```
+
+### From Source
+
+```bash
+git clone <repository_url>
+cd kfc
+npm install
+npm run build
+npm link
+kfc --help
+```
+
+---
+
+## 📖 Usage
+
+### Basic Usage
+
+```bash
+# Follow logs for a specific deployment
+kfc my-deployment
+
+# Specify namespace
+kfc -n production my-deployment
+
+# Specify context and namespace
+kfc -c staging-cluster -n production my-deployment
+
+# Custom tail lines
+kfc --tail 200 my-deployment
+
+# Custom retry attempts
+kfc --max-retry 5 my-deployment
+```
+
+### Interactive Mode
+
+```bash
+# Without deployment name, shows interactive selector
+kfc -n production
+
+# Output:
+# Select deployment:
+# ❯ app-deployment
+#   api-deployment
+#   worker-deployment
+```
+
+---
+
+## 🎨 Syntax Highlighting
+
+KFC provides rich syntax highlighting for various log formats:
+
+### Log Levels
+
+- 🔴 **ERROR/FATAL** - Red bold
+- 🟡 **WARN/WARNING** - Yellow
+- 🟢 **INFO** - Green
+- 🔵 **DEBUG** - Cyan
+- ⚪ **TRACE** - White
+
+### Syntax Elements
+
+- 🔵 **Timestamps** - Blue (ISO 8601)
+- 🟢 **Strings** - Green (`"..."`)
+- 🟣 **Numbers** - Magenta (`123`, `3.14`)
+- 🟡 **Booleans** - Yellow (`true`, `false`)
+- ⚫ **Null** - Gray (`null`)
+- 🔵 **URLs** - Blue underlined
+- 🟣 **IP Addresses** - Magenta
+- 🔵 **File Paths** - Cyan
+
+### JSON Support
+
+```json
+{
+  "timestamp": "2026-01-29T13:00:00Z", // Cyan key, Green value
+  "level": "INFO", // Cyan key, Green value
+  "user_id": 12345, // Cyan key, Magenta number
+  "success": true, // Cyan key, Yellow boolean
+  "error": null // Cyan key, Gray null
+}
+```
+
+---
+
+## ⚙️ Configuration
+
+### Environment Variables
+
+```bash
+export KFC_NAMESPACE=production    # Default namespace
+export KFC_TAIL_LINES=200          # Default tail lines
+export KFC_MAX_RETRY=5             # Default max retry attempts
+```
+
+### Command Line Options
+
+```bash
+kfc --help
+
+Options:
+  --namespace, -n  Kubernetes namespace (default: default)
+  --context, -c    Kubernetes context
+  --tail           Number of lines to show from the end (default: 100)
+  --max-retry      Maximum retry attempts (default: 10)
+  --grep, -g       Filter logs by pattern (regex supported)
+  --after, -A      Show N lines after match (default: 0)
+  --before, -B     Show N lines before match (default: 0)
+  --context, -C    Show N lines before and after match (default: 0)
+  --ignore-case, -i  Case-insensitive pattern matching
+  --invert, -v     Invert match (show non-matching lines)
+  --version, -v    Show version
+  --help, -h       Show help
+```
+
+---
+
+## 🛠️ Development
+
+### Project Structure
+
+```
+kfc/
+├── src/
+│   ├── cli.tsx              # CLI entry point
+│   ├── components/
+│   │   ├── App.tsx          # Main app component
+│   │   └── LogViewer.tsx    # Log viewer component
+│   ├── k8s/
+│   │   └── client.ts        # Kubernetes client
+│   └── utils/
+│       └── colorize.ts      # Colorization utilities
+├── dist/                    # Compiled output
+├── bin/kfc                  # CLI executable
+├── package.json
+└── tsconfig.json
+```
+
+### Development Commands
+
+```bash
+# Install dependencies
+npm install
+
+# Development mode (with tsx)
+npm run dev -- -n production my-deployment
+
+# Build
+npm run build
+
+# Run built version
+npm start -- --help
+
+# Test
+npm test
+```
+
+### Tech Stack
+
+- **TypeScript** - Type-safe JavaScript
+- **Ink** - React for CLI
+- **@kubernetes/client-node** - Official Kubernetes Node.js client
+- **chalk** - Terminal colors
+- **meow** - CLI argument parsing
+
+---
+
+## 📦 Dependencies
+
+### Required
+
+- ✅ **kubectl** - Kubernetes command-line tool
+- ✅ **Node.js** - v14 or higher
+
+### Not Required
+
+- ❌ kubecolor (built-in syntax highlighting)
+- ❌ fzf (built-in Ink selector)
+- ❌ Go toolchain
+
+---
+
+## 🎯 Why TypeScript + Ink?
+
+### Advantages
+
+- ✅ **Type Safety** - Full TypeScript type checking
+- ✅ **React for CLI** - Build CLI with React components
+- ✅ **Rich UI** - Built-in Spinner, SelectInput, and more
+- ✅ **Easy Maintenance** - Familiar React development patterns
+- ✅ **npx Friendly** - Run directly with `npx @logan/kfc`
+- ✅ **No Compilation Dependencies** - No need for Go toolchain
+
+### Comparison with Other Approaches
+
+| Feature        | zsh Script              | Go CLI        | TypeScript + Ink |
+| -------------- | ----------------------- | ------------- | ---------------- |
+| Language       | Shell                   | Go            | TypeScript       |
+| UI Framework   | None                    | None          | Ink (React)      |
+| Type Safety    | ❌                      | ✅            | ✅               |
+| Cross-platform | ❌                      | ✅            | ✅               |
+| npx Support    | ❌                      | Needs wrapper | ✅ Native        |
+| Development    | Simple                  | Traditional   | React Components |
+| Dependencies   | kubectl, kubecolor, fzf | kubectl       | kubectl, Node.js |
+
+---
+
+## 🐛 Troubleshooting
+
+### Deployment Not Found
+
+```bash
+# Check if namespace is correct
+kubectl get deployments -n <namespace>
+
+# Use correct namespace
+kfc -n <namespace>
+```
+
+### Cannot Connect to Kubernetes
+
+```bash
+# Check kubectl configuration
+kubectl config current-context
+kubectl get pods
+
+# Specify context
+kfc -c <context> -n <namespace>
+```
+
+### Node.js Version Too Old
+
+```bash
+# Check Node.js version
+node --version
+
+# Requires v14 or higher
+# Use nvm to upgrade
+nvm install 18
+nvm use 18
+```
+
+---
+
+## 📚 Documentation
+
+- [README_TS.md](README_TS.md) - Detailed TypeScript version documentation
+- [COLOR_OUTPUT.md](COLOR_OUTPUT.md) - Color output features
+- [KUBERNETES_SETUP.md](KUBERNETES_SETUP.md) - Kubernetes environment setup
+
+---
+
+## 📝 License
+
+MIT
+
+---
+
+## 🙏 Acknowledgments
+
+- [Ink](https://github.com/vadimdemedes/ink) - React for CLI
+- [kubectl](https://kubernetes.io/docs/reference/kubectl/) - Kubernetes CLI
+- [@kubernetes/client-node](https://github.com/kubernetes-client/javascript) - Kubernetes Node.js client
+- [chalk](https://github.com/chalk/chalk) - Terminal colors
+
+---
+
+## 🎊 Get Started
+
+```bash
+# Try it now!
+npx @logan/kfc -n kube-system coredns
+
+# Or install globally
+npm install -g @logan/kfc
+kfc --help
+```
+
+**Enjoy beautiful Kubernetes logs!** 🚀✨

package/dist/cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/cli.js

@@ -0,0 +1,95 @@
+#!/usr/bin/env node
+import React from 'react';
+import { render } from 'ink';
+import meow from 'meow';
+import App from './components/App.js';
+const cli = meow(`
+	Usage
+	  $ kfc [deployment-name]
+
+	Options
+	  --namespace, -n  Kubernetes namespace (default: default)
+	  --context, -c    Kubernetes context
+	  --tail           Number of lines to show from the end (default: 100)
+	  --max-retry      Maximum retry attempts (default: 10)
+	  --timeout        Connection timeout in seconds (default: 10)
+	  --grep, -g       Filter logs by pattern (regex supported)
+	  --after, -A      Show N lines after match (default: 0)
+	  --before, -B     Show N lines before match (default: 0)
+	  --context, -C    Show N lines before and after match (default: 0)
+	  --ignore-case, -i  Case-insensitive pattern matching
+	  --invert, -v     Invert match (show non-matching lines)
+	  --version        Show version
+	  --help, -h       Show help
+
+	Examples
+	  $ kfc my-deployment
+	  $ kfc -n production my-deployment
+	  $ kfc -c staging-cluster -n production my-deployment
+	  $ kfc --tail 200 my-deployment
+	  $ kfc --grep "ERROR" my-deployment
+	  $ kfc -g "user.*login" -A 3 -B 2 my-deployment
+	  $ kfc -g "payment" -C 5 my-deployment
+	  $ kfc -g "success" -i my-deployment
+`, {
+    importMeta: import.meta,
+    flags: {
+        namespace: {
+            type: 'string',
+            shortFlag: 'n',
+            default: process.env.KFC_NAMESPACE || 'default',
+        },
+        context: {
+            type: 'string',
+            shortFlag: 'c',
+        },
+        tail: {
+            type: 'number',
+            default: parseInt(process.env.KFC_TAIL_LINES || '100'),
+        },
+        maxRetry: {
+            type: 'number',
+            default: parseInt(process.env.KFC_MAX_RETRY || '10'),
+        },
+        timeout: {
+            type: 'number',
+            default: parseInt(process.env.KFC_TIMEOUT || '10'),
+        },
+        grep: {
+            type: 'string',
+            shortFlag: 'g',
+        },
+        after: {
+            type: 'number',
+            shortFlag: 'A',
+            default: 0,
+        },
+        before: {
+            type: 'number',
+            shortFlag: 'B',
+            default: 0,
+        },
+        contextLines: {
+            type: 'number',
+            shortFlag: 'C',
+            default: 0,
+        },
+        ignoreCase: {
+            type: 'boolean',
+            shortFlag: 'i',
+            default: false,
+        },
+        invert: {
+            type: 'boolean',
+            shortFlag: 'v',
+            default: false,
+        },
+        version: {
+            type: 'boolean',
+        },
+    },
+});
+const app = render(React.createElement(App, { deploymentName: cli.input[0], namespace: cli.flags.namespace, context: cli.flags.context, tail: cli.flags.tail, maxRetry: cli.flags.maxRetry, timeout: cli.flags.timeout, grepPattern: cli.flags.grep, grepAfter: cli.flags.after, grepBefore: cli.flags.before, grepContext: cli.flags.contextLines, grepIgnoreCase: cli.flags.ignoreCase, grepInvert: cli.flags.invert }));
+await app.waitUntilExit();
+process.exit(0);
+//# sourceMappingURL=cli.js.map

package/dist/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.tsx"],"names":[],"mappings":";AACA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,MAAM,EAAE,MAAM,KAAK,CAAC;AAC7B,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,GAAG,MAAM,qBAAqB,CAAC;AAEtC,MAAM,GAAG,GAAG,IAAI,CACf;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA4BA,EACA;IACC,UAAU,EAAE,MAAM,CAAC,IAAI;IACvB,KAAK,EAAE;QACN,SAAS,EAAE;YACV,IAAI,EAAE,QAAQ;YACd,SAAS,EAAE,GAAG;YACd,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,aAAa,IAAI,SAAS;SAC/C;QACD,OAAO,EAAE;YACR,IAAI,EAAE,QAAQ;YACd,SAAS,EAAE,GAAG;SACd;QACD,IAAI,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,IAAI,KAAK,CAAC;SACtD;QACD,QAAQ,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,IAAI,IAAI,CAAC;SACpD;QACD,OAAO,EAAE;YACR,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,IAAI,IAAI,CAAC;SAClD;QACD,IAAI,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,SAAS,EAAE,GAAG;SACd;QACD,KAAK,EAAE;YACN,IAAI,EAAE,QAAQ;YACd,SAAS,EAAE,GAAG;YACd,OAAO,EAAE,CAAC;SACV;QACD,MAAM,EAAE;YACP,IAAI,EAAE,QAAQ;YACd,SAAS,EAAE,GAAG;YACd,OAAO,EAAE,CAAC;SACV;QACD,YAAY,EAAE;YACb,IAAI,EAAE,QAAQ;YACd,SAAS,EAAE,GAAG;YACd,OAAO,EAAE,CAAC;SACV;QACD,UAAU,EAAE;YACX,IAAI,EAAE,SAAS;YACf,SAAS,EAAE,GAAG;YACd,OAAO,EAAE,KAAK;SACd;QACD,MAAM,EAAE;YACP,IAAI,EAAE,SAAS;YACf,SAAS,EAAE,GAAG;YACd,OAAO,EAAE,KAAK;SACd;QACD,OAAO,EAAE;YACR,IAAI,EAAE,SAAS;SACf;KACD;CACD,CACD,CAAC;AAEF,MAAM,GAAG,GAAG,MAAM,CACjB,oBAAC,GAAG,IACH,cAAc,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAC5B,SAAS,EAAE,GAAG,CAAC,KAAK,CAAC,SAAS,EAC9B,OAAO,EAAE,GAAG,CAAC,KAAK,CAAC,OAAO,EAC1B,IAAI,EAAE,GAAG,CAAC,KAAK,CAAC,IAAI,EACpB,QAAQ,EAAE,GAAG,CAAC,KAAK,CAAC,QAAQ,EAC5B,OAAO,EAAE,GAAG,CAAC,KAAK,CAAC,OAAO,EAC1B,WAAW,EAAE,GAAG,CAAC,KAAK,CAAC,IAAI,EAC3B,SAAS,EAAE,GAAG,CAAC,KAAK,CAAC,KAAK,EAC1B,UAAU,EAAE,GAAG,CAAC,KAAK,CAAC,MAAM,EAC5B,WAAW,EAAE,GAAG,CAAC,KAAK,CAAC,YAAY,EACnC,cAAc,EAAE,GAAG,CAAC,KAAK,CAAC,UAAU,EACpC,UAAU,EAAE,GAAG,CAAC,KAAK,CAAC,MAAM,GAC3B,CACF,CAAC;AAEF,MAAM,GAAG,CAAC,aAAa,EAAE,CAAC;AAC1B,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC"}

package/dist/components/App.d.ts

@@ -0,0 +1,17 @@
+import React from 'react';
+interface AppProps {
+    deploymentName?: string;
+    namespace: string;
+    context?: string;
+    tail: number;
+    maxRetry: number;
+    timeout: number;
+    grepPattern?: string;
+    grepAfter?: number;
+    grepBefore?: number;
+    grepContext?: number;
+    grepIgnoreCase?: boolean;
+    grepInvert?: boolean;
+}
+export default function App({ deploymentName: initialDeployment, namespace: initialNamespace, context: initialContext, tail, maxRetry, timeout, grepPattern, grepAfter, grepBefore, grepContext, grepIgnoreCase, grepInvert, }: AppProps): React.JSX.Element | null;
+export {};