diff --git a/packages/osr-code-bot/README.md b/packages/osr-code-bot/README.md index 57e8492..e9eb307 100644 --- a/packages/osr-code-bot/README.md +++ b/packages/osr-code-bot/README.md @@ -130,6 +130,7 @@ When creating content ### Initialize folder ```kbot init``` + # Command Line Parameters This document describes all available command line parameters. diff --git a/packages/osr-code-bot/dist/README.md b/packages/osr-code-bot/dist/README.md index 6c1614f..e9eb307 100644 --- a/packages/osr-code-bot/dist/README.md +++ b/packages/osr-code-bot/dist/README.md @@ -1,4 +1,4 @@ -# @plastichub/code-bot +# @plastichub/kbot AI-powered command-line tool for code modifications and project management that supports multiple AI models and routers. @@ -42,7 +42,7 @@ KBot supports both OpenRouter and OpenAI APIs. You'll need at least one of these ### Installation using Node NPM package manager ```bash -npm install -g @plastichub/code-bot +npm install -g @plastichub/kbot ``` ## Configuration @@ -78,6 +78,9 @@ Create configuration at `$HOME/.osr/.config.json` (or export OSR_CONFIG with pat "serpapi": { "key": "your SerpAPI key (optional, used for web searches(places, google maps))" }, + "deepseek": { + "key": "your SerpAPI key (optional, used for web searches(places, google maps))" + }, } ``` @@ -106,6 +109,28 @@ When creating content - always add links - when sending emails, always add 'Best regards, [Your Name]' ``` +## Commands + +### Prompt + +```kbot "create Astro minimal boilerplate, use starlight theme. Install dependencies via NPM tool"``` + +### Fetch latest models + +```kbot fetch``` + +### Print examples + +```kbot examples``` + +### Print extended help + +```kbot help-md``` + +### Initialize folder + +```kbot init``` + # Command Line Parameters This document describes all available command line parameters. @@ -117,11 +142,18 @@ This document describes all available command line parameters. | `path` | Target directory | `.` | No | | `prompt` | The prompt. Supports file paths and environment variables | `./prompt.md` | No | | `output` | Optional output path for modified files (Tool mode only) | - | No | -| `dst` | Optional destination path for the result, will substitute ${MODEL} and ${ROUTER} in the path. Used for "completion" mode | - | No | +| `dst` | Optional destination path for the result, will substitute ${MODEL} and ${ROUTER} in the path. | - | No | | `model` | AI model to use for processing | `anthropic/claude-3.5-sonnet` | No | | `router` | Router to use: openai or openrouter | `openrouter` | No | | `mode` | Chat completion mode: "completion" (without tools) or "tools" | `tools` | No | +## Advanced Parameters + +| Parameter | Description | Default | Required | +|-----------|-------------|---------|----------| +| `each` | Target directory | `.` | No | +| `dry` | Dry run - only write out parameters without making API calls | `false` | No | + ## File Selection & Tools | Parameter | Description | Default | Required | @@ -146,35 +178,7 @@ This document describes all available command line parameters. | `logLevel` | Logging level for the application (0-4) | `2` | No | | `logs` | Logging directory | `./.kbot` | No | | `dump` | Create a script | - | No | -| `dry` | Dry run - only write out parameters without making API calls | `false` | No | -## Examples - -```bash -# Basic usage with default parameters -kbot --prompt="What are the changes needed?" - -# Specify model and router -kbot --model="gpt-4" --router="openai" --prompt="Analyze this code" - -# Process specific files -kbot --include="src/*.ts" --include="package.json" --prompt="Check for security issues" - -# Dry run with custom logging -kbot --dry=true --logLevel=4 --prompt="Test run" -``` - -## Environment Variables - -Many path-based parameters support environment variables using the `${VARIABLE}` syntax: - -- `${POLYMECH-ROOT}` - Root directory for Polymech -- `${OSR-ROOT}` - Root directory for OSR - -Example: -```bash -kbot --profile="${POLYMECH-ROOT}/custom-profile.json" -``` # Working on Larger Directories diff --git a/packages/osr-code-bot/dist/package-lock.json b/packages/osr-code-bot/dist/package-lock.json index 33b58c5..178752e 100644 --- a/packages/osr-code-bot/dist/package-lock.json +++ b/packages/osr-code-bot/dist/package-lock.json @@ -1,12 +1,12 @@ { "name": "@plastichub/kbot", - "version": "1.1.9", + "version": "1.1.12", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@plastichub/kbot", - "version": "1.1.9", + "version": "1.1.12", "license": "ISC", "dependencies": { "node-emoji": "^2.2.0" diff --git a/packages/osr-code-bot/dist/package.json b/packages/osr-code-bot/dist/package.json index a6a889f..4832020 100644 --- a/packages/osr-code-bot/dist/package.json +++ b/packages/osr-code-bot/dist/package.json @@ -1,6 +1,6 @@ { "name": "@plastichub/kbot", - "version": "1.1.9", + "version": "1.1.12", "main": "main_node.js", "author": "", "license": "ISC", diff --git a/packages/osr-code-bot/dist/stats/statistics.html b/packages/osr-code-bot/dist/stats/statistics.html index bd9cd46..70421ef 100644 --- a/packages/osr-code-bot/dist/stats/statistics.html +++ b/packages/osr-code-bot/dist/stats/statistics.html @@ -188,7 +188,7 @@ footer h2 {
-