@thejeetsingh/kalcode 2.2.0 → 2.2.1

package/README.md

@@ -1,138 +1,138 @@
-# kalcode
+# Kalcode
 
-CLI coding agent powered by NVIDIA NIM.
+Kalcode is a terminal-native coding assistant powered by NVIDIA NIM.
 
-## Install
+It supports both Node.js and Bun runtimes, includes a Claude-style TUI, and can run with:
+- your own NVIDIA API key, or
+- the hosted proxy endpoint (`https://kalcode.vercel.app`) with zero client setup.
 
-Global install:
+## Installation
 
-```bash
-npm i -g @thejeetsingh/kalcode
-```
+### npm (recommended)
 
-Run without global install:
+Run directly:
 
 ```bash
-npx @thejeetsingh/kalcode --version
+npx @thejeetsingh/kalcode
 ```
 
-## Usage
+Install globally:
 
 ```bash
-kalcode "your prompt here"
+npm install -g @thejeetsingh/kalcode
+kalcode
 ```
 
-## Publish to npm
-
-1. Login:
+### Bun
 
 ```bash
-npm login
+bunx @thejeetsingh/kalcode
 ```
 
-2. Check what will be published:
+## Quick Start
 
 ```bash
-npm pack --dry-run
+kalcode "review the repository and suggest improvements"
 ```
 
-3. Publish:
+By default, Kalcode can use the hosted proxy.  
+If you want to use your own provider key locally:
 
 ```bash
-npm publish --access public
+kalcode --set-key
 ```
 
-4. Verify:
+## Configuration
 
-```bash
-npm view @thejeetsingh/kalcode version
-```
-
-## Deployment and Secrets
+### Environment Variables
 
-- Do not hardcode API keys in source files.
-- Set `NVIDIA_NIM_KEY` in your shell or deployment environment.
-- Use `kalcode --set-key` to store the key in `~/.kalcode/config.json` for local development.
-- TLS verification is on by default. Do not disable it in production.
-- `KALCODE_INSECURE_TLS=1` is available only as a local debugging escape hatch.
+- `NVIDIA_NIM_KEY`: NVIDIA NIM API key (server-side for proxy deployments, optional on clients if proxy is used)
+- `KALCODE_PROXY_URL`: Optional override for custom proxy URL
+- `KALCODE_INSECURE_TLS=1`: Local debugging only; never use in production
 
-## Secure Proxy Mode (share access without sharing your NVIDIA key)
+## Deployment (Vercel Serverless Proxy)
 
-Run the backend proxy with your NVIDIA key on a server you control:
+This repository provides:
+- `POST /v1/chat/completions` -> `/api/v1/chat/completions`
+- `GET /health` -> `/api/health`
 
-```bash
-export NVIDIA_NIM_KEY="your-real-provider-key"
-export PORT=8787
-bun run proxy
-```
+### Steps
 
-Client users run `kalcode` with proxy settings (no NVIDIA key needed on client):
+1. Import the `kalcode` directory as a Vercel project.
+2. Ensure project settings match:
+   - Framework Preset: `Other`
+   - Build Command: `npm run build`
+   - Output Directory: `dist`
+3. Add environment variable:
+   - `NVIDIA_NIM_KEY=your_real_key`
+4. Deploy and verify:
 
 ```bash
-export KALCODE_PROXY_URL="https://your-proxy-domain"
-kalcode
+curl https://kalcode.vercel.app/health
 ```
 
-Optional server hardening vars:
+Expected response:
 
-- `KALCODE_PROXY_RATE_LIMIT_PER_MIN` - per-client request cap (default `120`)
-- `HOST` - bind host (default `0.0.0.0`)
-- `PORT` - bind port (default `8787`)
+```json
+{"ok":true}
+```
 
-Health check endpoint:
+## CLI Options
+
+- `-h, --help` Show help
+- `-v, --version` Show version
+- `-m, --model <id>` Use a specific model
+- `--set-key` Save NVIDIA NIM API key to local config
+- `--compact` Toggle compact output
+- `--auto-accept` Skip permission prompts
+- `--ask` Read-only mode
+
+## REPL Slash Commands
+
+- `/` Show command menu
+- `/help` Show help
+- `/model` Show or switch model
+- `/clear` Clear conversation and context
+- `/retry` Retry last message
+- `/compact` Toggle compact output
+- `/ask` Toggle read-only mode
+- `/auto` Toggle auto-accept permissions
+- `/skills` List available skills
+- `/add <file>` Add file to context
+- `/drop <file>` Remove file from context
+- `/files` List context files
+- `/diff` Show uncommitted changes
+- `/status` Show git status
+- `/log` Show recent commits
+- `/undo` Undo last commit
+- `/commit [message]` Commit all changes
+- `/init` Create `KALCODE.md`
+- `/exit`, `/quit`, `/q` Quit
+
+## Development
+
+Install dependencies:
 
 ```bash
-curl https://your-proxy-domain/health
+npm install
 ```
 
-## Vercel Deployment (serverless)
-
-This repo now includes Vercel serverless endpoints:
-
-- `POST /v1/chat/completions` (rewritten to `/api/v1/chat/completions`)
-- `GET /health` (rewritten to `/api/health`)
-
-### 1) Deploy
-
-- Import the `kalcode` folder as a Vercel project.
-- Framework preset: **Other**.
-- Build command: leave default/empty.
-
-### 2) Set Vercel environment variables
-
-- `NVIDIA_NIM_KEY` = your provider key (server-only)
-
-### 3) Configure clients
+Build:
 
 ```bash
-export KALCODE_PROXY_URL="https://<your-vercel-project>.vercel.app"
-kalcode
+npm run build
 ```
 
-### 4) Verify
+Run locally:
 
 ```bash
-curl https://<your-vercel-project>.vercel.app/health
+npm run start
 ```
 
-## Options
-
-- `-h, --help` - Show help
-- `-v, --version` - Show version
-- `-m, --model <id>` - Use a specific model
-- `--set-key` - Set NVIDIA NIM API key
-- `--compact` - Compact output
-- `--auto-accept` - Skip permission prompts
-- `--ask` - Read-only mode
-
-## REPL Commands
-
-- `/help` - Show help
-- `/model` - Show or switch model
-- `/clear` - Clear conversation
-- `/retry` - Retry last message
-- `/compact` - Toggle compact output
-- `/ask` - Toggle read-only mode
-- `/skills` - List skills
-- `/` - Show slash commands
-- `/exit` - Quit
+## Publishing
+
+```bash
+npm login
+npm run build
+npm publish --access public
+```

package/dist/src/constants.d.ts

@@ -1,4 +1,4 @@
-export declare const VERSION = "2.2.0";
+export declare const VERSION = "2.2.1";
 export declare const API_URL = "https://integrate.api.nvidia.com/v1/chat/completions";
 /** Public proxy — used automatically when no API key is set */
 export declare const DEFAULT_PROXY_URL = "https://kalcode.vercel.app";

package/dist/src/constants.js

@@ -1,4 +1,4 @@
-export const VERSION = "2.2.0";
+export const VERSION = "2.2.1";
 export const API_URL = "https://integrate.api.nvidia.com/v1/chat/completions";
 /** Public proxy — used automatically when no API key is set */
 export const DEFAULT_PROXY_URL = "https://kalcode.vercel.app";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thejeetsingh/kalcode",
-  "version": "2.2.0",
+  "version": "2.2.1",
   "description": "CLI coding agent powered by NVIDIA NIM — works with npm and bun",
   "author": "Jeet Singh",
   "license": "MIT",