@renxqoo/renx-code 0.0.10 → 0.0.12

package/README.md

@@ -1,9 +1,20 @@
-# Renx
+# Renx Code
 
-`renx` is a terminal AI coding assistant for reading code, editing files, fixing errors, and working directly inside your current project.
+`renx` is a terminal AI coding assistant.
 
-- npm package: `@renxqoo/renx-code`
-- command: `renx`
+- Package: `@renxqoo/renx-code`
+- Command: `renx`
+
+## Features
+
+`renx` can help you:
+
+- read and explain a codebase
+- edit files directly in your project
+- fix build errors and runtime errors
+- generate code, tests, and scripts
+- inspect logs and terminal output
+- work inside the current directory as the active workspace
 
 ## Install
 
@@ -11,81 +22,33 @@ Requirements:
 
 - Node.js `20+`
 
-Install globally:
+Install:
 
 ```bash
 npm i -g @renxqoo/renx-code --registry=https://registry.npmjs.org
 ```
 
-Start:
+Run:
 
 ```bash
 renx
 ```
 
-Published npm packages include a prebuilt executable, so end users do not need to install Bun.
-
-## Quick Start
-
-Open a project directory and run:
-
-```bash
-cd your-project
-renx
-```
-
-`renx` uses the current terminal directory as the workspace by default.
-
-Common things you can ask it to do:
-
-- explain a codebase or a single file
-- fix build or runtime errors
-- modify files directly
-- help write features, tests, and scripts
-- investigate logs and terminal output
-
-Built-in commands:
-
-- `/help`
-- `/clear`
-- `/exit`
-
-Keyboard shortcuts:
-
-- `Esc`: stop the current response, or clear the current input
-- `Ctrl + L`: clear the current conversation
-
 ## Configuration
 
-Configuration priority:
-
-1. process environment variables and `.env` / `.env.development`
-2. project config: `<workspace>/.renx/config.json`
-3. global config: `RENX_HOME/config.json`
-4. built-in defaults
-
-Default user data locations:
+Config locations:
 
-- `RENX_HOME`, default: `~/.renx`
-- `RENX_HOME/config.json`
-- `RENX_HOME/logs/`
-- `RENX_HOME/storage/`
-- `RENX_HOME/task/`
-- `RENX_HOME/data.db`
-
-Project config example:
-
-```text
-your-project/.renx/config.json
-```
+- global: `~/.renx/config.json`
+- project: `<your-project>/.renx/config.json`
 
-Global config example:
+Priority:
 
-```text
-~/.renx/config.json
-```
+1. environment variables
+2. project config
+3. global config
+4. defaults
 
-## Basic Config Example
+Example:
 
 ```json
 {
@@ -94,95 +57,18 @@ Global config example:
     "maxSteps": 10000,
     "confirmationMode": "manual"
   },
-  "log": {
-    "level": "INFO",
-    "format": "pretty",
-    "console": true,
-    "file": false
-  },
-  "storage": {
-    "fileHistory": {
-      "enabled": true,
-      "maxPerFile": 20,
-      "maxAgeDays": 14,
-      "maxTotalMb": 500
-    }
-  }
-}
-```
-
-## Custom Model Config
-
-You can define your own model in global or project `config.json` and then point `agent.defaultModel` to it.
-
-Example:
-
-```json
-{
-  "agent": {
-    "defaultModel": "my-openai-compatible"
-  },
   "models": {
-    "my-openai-compatible": {
+    "my-model": {
       "provider": "openai",
-      "name": "My OpenAI Compatible",
-      "baseURL": "https://example.com/v1",
-      "endpointPath": "/chat/completions",
-      "envApiKey": "MY_API_KEY",
-      "envBaseURL": "MY_API_BASE",
-      "model": "my-model",
-      "max_tokens": 8000,
-      "LLMMAX_TOKENS": 128000,
-      "features": ["streaming", "function-calling"]
-    },
-    "gpt-5.4": {
-      "baseURL": "https://my-proxy.example.com/v1"
+      "name": "My Model",
+      "baseURL": "https://api.openai.com/v1",
+      "envApiKey": "OPENAI_API_KEY",
+      "model": "gpt-5.4"
     }
   }
 }
 ```
 
-This supports both:
-
-- adding a completely new model
-- overriding part of a built-in model, such as `baseURL`
-
-## Environment Variables
-
-Runtime:
-
-- `RENX_HOME`
-- `AGENT_MODEL`
-- `AGENT_MAX_STEPS`
-- `AGENT_MAX_RETRY_COUNT`
-- `AGENT_TOOL_CONFIRMATION_MODE`
-- `AGENT_CONVERSATION_ID`
-- `AGENT_SESSION_ID`
-
-Logging:
-
-- `AGENT_LOG_LEVEL`
-- `AGENT_LOG_FORMAT`
-- `AGENT_LOG_CONSOLE`
-- `AGENT_LOG_FILE_ENABLED`
-
-File history:
-
-- `AGENT_FILE_HISTORY_ENABLED`
-- `AGENT_FILE_HISTORY_MAX_PER_FILE`
-- `AGENT_FILE_HISTORY_MAX_AGE_DAYS`
-- `AGENT_FILE_HISTORY_MAX_TOTAL_MB`
-
-Custom models:
-
-- `RENX_CUSTOM_MODELS_JSON`
-
-Provider API keys are passed through their own environment variables, for example:
-
-- `OPENAI_API_KEY`
-- `GLM_API_KEY`
-- `QWEN_API_KEY`
-
 ## Publish
 
 Useful local release commands:
@@ -200,15 +86,3 @@ Version rules:
 - `publish:patch`: small fix, `0.0.1`
 - `publish:minor`: new feature, `0.1.0`
 - `publish:major`: breaking change or refactor, `1.0.0`
-
-## Maintainers
-
-Maintainers need Bun to build and publish the precompiled binary package.
-
-Install Bun:
-
-```bash
-powershell -c "irm bun.sh/install.ps1 | iex"
-```
-
-Current release builds the executable for the platform used during publishing. For example, publishing on Windows x64 produces a Windows x64 npm package.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@renxqoo/renx-code",
-  "version": "0.0.10",
-  "description": "Renx terminal AI coding assistant",
+  "version": "0.0.12",
+  "description": "Renx Code terminal AI coding assistant",
   "type": "commonjs",
   "private": false,
   "os": [