@renxqoo/renx-code 0.0.8 → 0.0.10

package/README.md

@@ -1,6 +1,6 @@
 # Renx
 
-`renx` is a terminal AI coding assistant.
+`renx` is a terminal AI coding assistant for reading code, editing files, fixing errors, and working directly inside your current project.
 
 - npm package: `@renxqoo/renx-code`
 - command: `renx`
@@ -23,24 +23,26 @@ Start:
 renx
 ```
 
-No separate Bun installation is required for published npm installs.
+Published npm packages include a prebuilt executable, so end users do not need to install Bun.
 
-## Basic Usage
+## Quick Start
 
-Run `renx` inside any project directory:
+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 do:
+Common things you can ask it to do:
 
-- read and explain code
-- modify files
-- investigate errors
-- work inside the current project directory
+- 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:
 
@@ -71,6 +73,80 @@ Default user data locations:
 - `RENX_HOME/task/`
 - `RENX_HOME/data.db`
 
+Project config example:
+
+```text
+your-project/.renx/config.json
+```
+
+Global config example:
+
+```text
+~/.renx/config.json
+```
+
+## Basic Config Example
+
+```json
+{
+  "agent": {
+    "defaultModel": "qwen3.5-plus",
+    "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": {
+      "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"
+    }
+  }
+}
+```
+
+This supports both:
+
+- adding a completely new model
+- overriding part of a built-in model, such as `baseURL`
+
 ## Environment Variables
 
 Runtime:
@@ -97,44 +173,42 @@ File history:
 - `AGENT_FILE_HISTORY_MAX_AGE_DAYS`
 - `AGENT_FILE_HISTORY_MAX_TOTAL_MB`
 
-Provider API keys are still passed through their own environment variables, for example:
+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`
 
-## Config Example
+## Publish
 
-```json
-{
-  "agent": {
-    "defaultModel": "qwen3.5-plus",
-    "maxSteps": 10000,
-    "confirmationMode": "manual"
-  },
-  "log": {
-    "level": "INFO",
-    "format": "pretty",
-    "console": true,
-    "file": false
-  },
-  "storage": {
-    "fileHistory": {
-      "enabled": true,
-      "maxPerFile": 20,
-      "maxAgeDays": 14,
-      "maxTotalMb": 500
-    }
-  }
-}
+Useful local release commands:
+
+```bash
+npm run pack:dry
+npm run pack:tgz
+npm run publish:patch
+npm run publish:minor
+npm run publish:major
 ```
 
-Project config example:
+Version rules:
 
-```text
-your-project/.renx/config.json
-```
+- `publish:patch`: small fix, `0.0.1`
+- `publish:minor`: new feature, `0.1.0`
+- `publish:major`: breaking change or refactor, `1.0.0`
 
-Global config example:
+## Maintainers
 
-```text
-~/.renx/config.json
+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/bin/renx.cjs

@@ -5,51 +5,88 @@ const fs = require("node:fs");
 const path = require("node:path");
 
 const packageRoot = path.resolve(__dirname, "..");
-const entryPath = path.join(packageRoot, "src", "index.tsx");
-const packagedRepoRoot = path.join(packageRoot, "vendor", "agent-root");
-const localRepoRoot = path.resolve(packageRoot, "..");
-const nodeExecutable = process.env.RENX_NODE_PATH || process.execPath;
-
-const hasAgentSourceRoot = root =>
-  fs.existsSync(path.join(root, "src", "providers", "index.ts")) &&
-  fs.existsSync(path.join(root, "src", "config", "index.ts")) &&
-  fs.existsSync(path.join(root, "src", "agent", "app", "index.ts"));
-
-const resolvedRepoRoot =
-  process.env.AGENT_REPO_ROOT ||
-  (hasAgentSourceRoot(packagedRepoRoot)
-    ? packagedRepoRoot
-    : hasAgentSourceRoot(localRepoRoot)
-      ? localRepoRoot
-      : undefined);
-
-if (!fs.existsSync(entryPath)) {
-  console.error(`Could not find CLI entrypoint: ${entryPath}`);
-  process.exit(1);
+const binaryName = process.platform === "win32" ? "renx.exe" : "renx";
+
+function run(target, args, env = process.env) {
+  const result = childProcess.spawnSync(target, args, {
+    cwd: process.cwd(),
+    stdio: "inherit",
+    env,
+  });
+
+  if (result.error) {
+    console.error(result.error.message);
+    process.exit(1);
+  }
+
+  process.exit(typeof result.status === "number" ? result.status : 0);
 }
 
-let tsxCliPath;
-try {
-  tsxCliPath = require.resolve("tsx/cli", { paths: [packageRoot] });
-} catch (error) {
-  const message = error instanceof Error ? error.message : String(error);
-  console.error(`Could not resolve tsx runtime from this installation: ${message}`);
-  process.exit(1);
+function resolveBunExecutable() {
+  if (process.env.RENX_BUN_PATH) {
+    return process.env.RENX_BUN_PATH;
+  }
+
+  const candidates =
+    process.platform === "win32"
+      ? ["bun.exe", "bun.cmd", "bun"]
+      : ["bun"];
+
+  for (const candidate of candidates) {
+    const probe = childProcess.spawnSync(candidate, ["--version"], {
+      stdio: "ignore",
+    });
+
+    if (!probe.error && probe.status === 0) {
+      return candidate;
+    }
+  }
+
+  return null;
 }
 
-const result = childProcess.spawnSync(nodeExecutable, [tsxCliPath, entryPath, ...process.argv.slice(2)], {
-  cwd: process.cwd(),
-  stdio: "inherit",
-  env: {
-    ...process.env,
-    AGENT_WORKDIR: process.env.AGENT_WORKDIR || process.cwd(),
-    ...(resolvedRepoRoot ? { AGENT_REPO_ROOT: resolvedRepoRoot } : {}),
-  },
-});
-
-if (result.error) {
-  console.error(result.error.message);
-  process.exit(1);
+function hasAgentSourceRoot(root) {
+  return (
+    fs.existsSync(path.join(root, "src", "providers", "index.ts")) &&
+    fs.existsSync(path.join(root, "src", "config", "index.ts")) &&
+    fs.existsSync(path.join(root, "src", "agent", "app", "index.ts"))
+  );
+}
+
+const binaryCandidates = [
+  process.env.RENX_BIN_PATH,
+  path.join(__dirname, binaryName),
+  path.join(packageRoot, "release", "publish", "bin", binaryName),
+].filter(Boolean);
+
+for (const candidate of binaryCandidates) {
+  if (fs.existsSync(candidate)) {
+    run(candidate, process.argv.slice(2));
+  }
+}
+
+const sourceEntry = path.join(packageRoot, "src", "index.tsx");
+if (fs.existsSync(sourceEntry)) {
+  const packagedRepoRoot = path.join(packageRoot, "vendor", "agent-root");
+  const localRepoRoot = path.resolve(packageRoot, "..");
+  const resolvedRepoRoot =
+    process.env.AGENT_REPO_ROOT ||
+    (hasAgentSourceRoot(packagedRepoRoot)
+      ? packagedRepoRoot
+      : hasAgentSourceRoot(localRepoRoot)
+        ? localRepoRoot
+        : undefined);
+  const bunExecutable = resolveBunExecutable();
+
+  if (bunExecutable) {
+    run(bunExecutable, ["run", sourceEntry, ...process.argv.slice(2)], {
+      ...process.env,
+      AGENT_WORKDIR: process.env.AGENT_WORKDIR || process.cwd(),
+      ...(resolvedRepoRoot ? { AGENT_REPO_ROOT: resolvedRepoRoot } : {}),
+    });
+  }
 }
 
-process.exit(typeof result.status === "number" ? result.status : 0);
+console.error(`Could not find Renx executable: expected ${binaryName} next to ${__filename}.`);
+console.error("Run `npm run release:prepare` to build a local binary, or set RENX_BIN_PATH.");
+process.exit(1);

package/package.json

@@ -1,41 +1,23 @@
 {
   "name": "@renxqoo/renx-code",
-  "version": "0.0.8",
-  "module": "src/index.tsx",
-  "type": "module",
+  "version": "0.0.10",
+  "description": "Renx terminal AI coding assistant",
+  "type": "commonjs",
   "private": false,
+  "os": [
+    "win32"
+  ],
+  "cpu": [
+    "x64"
+  ],
   "bin": {
     "renx": "./bin/renx.cjs"
   },
   "files": [
     "bin",
-    "src",
-    "vendor",
-    "README.md",
-    "tsconfig.json"
+    "README.md"
   ],
   "engines": {
     "node": ">=20.0.0"
-  },
-  "peerDependencies": {
-    "typescript": "^5.9.3"
-  },
-  "dependencies": {
-    "@opentui/core": "^0.1.84",
-    "@opentui/react": "^0.1.84",
-    "@vscode/ripgrep": "^1.17.0",
-    "diff": "^8.0.3",
-    "dotenv": "^17.3.1",
-    "js-tiktoken": "^1.0.21",
-    "log-update": "^6.1.0",
-    "marked": "^15.0.12",
-    "marked-terminal": "^7.3.0",
-    "minimatch": "^10.2.4",
-    "react": "^19.2.4",
-    "shell-quote": "^1.8.3",
-    "strip-ansi": "^7.2.0",
-    "uuid": "^13.0.0",
-    "zod": "^4.3.6",
-    "tsx": "^4.21.0"
   }
 }

package/src/App.tsx

@@ -1,297 +0,0 @@
-import { TextAttributes, type Selection } from '@opentui/core';
-import { useKeyboard, useRenderer, useTerminalDimensions } from '@opentui/react';
-import { useEffect, useRef, useState } from 'react';
-
-import { resolveSlashCommand, type SlashCommandDefinition } from './commands/slash-commands';
-import { ConversationPanel } from './components/conversation-panel';
-import { FilePickerDialog } from './components/file-picker-dialog';
-import { ModelPickerDialog } from './components/model-picker-dialog';
-import { Prompt } from './components/prompt';
-import { ToolConfirmDialog } from './components/tool-confirm-dialog';
-import { isMediaSelection } from './files/attachment-capabilities';
-import type { PromptFileSelection } from './files/types';
-import { useAgentChat } from './hooks/use-agent-chat';
-import { useFilePicker } from './hooks/use-file-picker';
-import { useModelPicker } from './hooks/use-model-picker';
-import { requestExit } from './runtime/exit';
-import { copyTextToClipboard } from './runtime/clipboard';
-import { uiTheme } from './ui/theme';
-
-const appendFileTokens = (currentValue: string, files: PromptFileSelection[]) => {
-  if (files.length === 0) {
-    return currentValue;
-  }
-
-  const existingTokens = new Set(currentValue.match(/@\/\S+/g) ?? []);
-  const newTokens = files
-    .filter(file => !isMediaSelection(file))
-    .map(file => `@/${file.relativePath}`)
-    .filter(token => !existingTokens.has(token));
-
-  if (newTokens.length === 0) {
-    return currentValue;
-  }
-
-  const trimmed = currentValue.trimEnd();
-  const separator = trimmed.length > 0 ? ' ' : '';
-  return `${trimmed}${separator}${newTokens.join(' ')} `;
-};
-
-export const App = () => {
-  const {
-    turns,
-    inputValue,
-    isThinking,
-    modelLabel,
-    contextUsagePercent,
-    pendingToolConfirm,
-    setInputValue,
-    selectedFiles,
-    setSelectedFiles,
-    appendSelectedFiles,
-    submitInput,
-    stopActiveReply,
-    clearInput,
-    resetConversation,
-    setModelLabelDisplay,
-    setToolConfirmSelection,
-    submitToolConfirmSelection,
-    rejectPendingToolConfirm,
-  } = useAgentChat();
-  const [slashMenuVisible, setSlashMenuVisible] = useState(false);
-  const modelPicker = useModelPicker({
-    onModelChanged: setModelLabelDisplay,
-  });
-  const filePicker = useFilePicker();
-  const dimensions = useTerminalDimensions();
-  const renderer = useRenderer();
-  const [copyToastVisible, setCopyToastVisible] = useState(false);
-  const selectionCopyTimeoutRef = useRef<ReturnType<typeof setTimeout> | null>(null);
-  const copyToastTimeoutRef = useRef<ReturnType<typeof setTimeout> | null>(null);
-
-  useEffect(() => {
-    const handleSelection = (selection: Selection) => {
-      const selectedText = selection.getSelectedText();
-      if (!selectedText) {
-        return;
-      }
-
-      if (selectionCopyTimeoutRef.current) {
-        clearTimeout(selectionCopyTimeoutRef.current);
-      }
-
-      selectionCopyTimeoutRef.current = setTimeout(() => {
-        void copyTextToClipboard(selectedText, renderer).then(success => {
-          if (!success) {
-            return;
-          }
-
-          setCopyToastVisible(true);
-          if (copyToastTimeoutRef.current) {
-            clearTimeout(copyToastTimeoutRef.current);
-          }
-          copyToastTimeoutRef.current = setTimeout(() => {
-            setCopyToastVisible(false);
-            copyToastTimeoutRef.current = null;
-          }, 1500);
-        });
-        selectionCopyTimeoutRef.current = null;
-      }, 80);
-    };
-
-    renderer.on('selection', handleSelection);
-
-    return () => {
-      renderer.off('selection', handleSelection);
-      if (selectionCopyTimeoutRef.current) {
-        clearTimeout(selectionCopyTimeoutRef.current);
-        selectionCopyTimeoutRef.current = null;
-      }
-      if (copyToastTimeoutRef.current) {
-        clearTimeout(copyToastTimeoutRef.current);
-        copyToastTimeoutRef.current = null;
-      }
-    };
-  }, [renderer]);
-
-  const submitWithCommands = () => {
-    const command = resolveSlashCommand(inputValue);
-    if (command?.action === 'models') {
-      setInputValue('');
-      modelPicker.open();
-      return;
-    }
-    if (command?.action === 'files') {
-      setInputValue('');
-      filePicker.open(selectedFiles);
-      return;
-    }
-
-    submitInput();
-  };
-
-  const handleSlashCommandSelect = (command: SlashCommandDefinition) => {
-    if (command.action === 'models') {
-      setInputValue('');
-      modelPicker.open();
-      return true;
-    }
-    if (command.action === 'files') {
-      setInputValue('');
-      filePicker.open(selectedFiles);
-      return true;
-    }
-    return false;
-  };
-
-  useKeyboard(key => {
-    if (key.ctrl && key.name === 'c') {
-      requestExit(0);
-      return;
-    }
-
-    if (modelPicker.visible) {
-      if (key.name === 'escape') {
-        modelPicker.close();
-      }
-      return;
-    }
-
-    if (filePicker.visible) {
-      if (key.name === 'escape') {
-        filePicker.close();
-      }
-      return;
-    }
-
-    if (pendingToolConfirm) {
-      if (key.name === 'left' || key.name === 'h') {
-        setToolConfirmSelection('approve');
-        return;
-      }
-
-      if (key.name === 'right' || key.name === 'l') {
-        setToolConfirmSelection('deny');
-        return;
-      }
-
-      if (key.name === 'return' || key.name === 'enter') {
-        submitToolConfirmSelection();
-        return;
-      }
-
-      if (key.name === 'escape') {
-        rejectPendingToolConfirm();
-      }
-      return;
-    }
-
-    if (key.ctrl && key.name === 'l') {
-      resetConversation();
-      return;
-    }
-
-    if (key.name === 'escape') {
-      if (slashMenuVisible) {
-        return;
-      }
-      if (isThinking) {
-        stopActiveReply();
-        return;
-      }
-      clearInput();
-    }
-  });
-
-  return (
-    <box
-      width={dimensions.width}
-      height={dimensions.height}
-      flexDirection="column"
-      backgroundColor={uiTheme.bg}
-      paddingTop={uiTheme.layout.appPaddingTop}
-      paddingBottom={uiTheme.layout.appPaddingBottom}
-      paddingLeft={uiTheme.layout.appPaddingX}
-      paddingRight={uiTheme.layout.appPaddingX}
-    >
-      <ConversationPanel turns={turns} isThinking={isThinking} />
-      <Prompt
-        isThinking={isThinking}
-        disabled={modelPicker.visible || filePicker.visible || Boolean(pendingToolConfirm)}
-        modelLabel={modelLabel}
-        contextUsagePercent={contextUsagePercent}
-        value={inputValue}
-        selectedFiles={selectedFiles}
-        onAddSelectedFiles={appendSelectedFiles}
-        onValueChange={setInputValue}
-        onSlashCommandSelect={handleSlashCommandSelect}
-        onSlashMenuVisibilityChange={setSlashMenuVisible}
-        onSubmit={submitWithCommands}
-      />
-      <ToolConfirmDialog
-        visible={Boolean(pendingToolConfirm)}
-        viewportWidth={dimensions.width}
-        viewportHeight={dimensions.height}
-        request={pendingToolConfirm}
-      />
-      <FilePickerDialog
-        visible={filePicker.visible}
-        viewportWidth={dimensions.width}
-        viewportHeight={dimensions.height}
-        loading={filePicker.loading}
-        error={filePicker.error}
-        search={filePicker.search}
-        options={filePicker.options}
-        selectedIndex={filePicker.selectedIndex}
-        selectedPaths={filePicker.selectedPaths}
-        onSearchChange={filePicker.setSearch}
-        onSelectIndex={filePicker.setSelectedIndex}
-        onToggleSelected={filePicker.toggleSelectedIndex}
-        onConfirm={() => {
-          const confirmedFiles = filePicker.confirmSelected();
-          setSelectedFiles(confirmedFiles);
-          setInputValue(appendFileTokens(inputValue, confirmedFiles));
-        }}
-        onListKeyDown={filePicker.handleListKeyDown}
-      />
-      <ModelPickerDialog
-        visible={modelPicker.visible}
-        viewportWidth={dimensions.width}
-        viewportHeight={dimensions.height}
-        loading={modelPicker.loading}
-        switching={modelPicker.switching}
-        error={modelPicker.error}
-        search={modelPicker.search}
-        options={modelPicker.options}
-        selectedIndex={modelPicker.selectedIndex}
-        onSearchChange={modelPicker.setSearch}
-        onSelectIndex={modelPicker.setSelectedIndex}
-        onConfirm={() => {
-          void modelPicker.confirmSelected();
-        }}
-        onListKeyDown={modelPicker.handleListKeyDown}
-      />
-      {copyToastVisible ? (
-        <box
-          position="absolute"
-          right={2}
-          top={1}
-          zIndex={20}
-          flexDirection="row"
-          gap={1}
-          borderColor={uiTheme.divider}
-          borderStyle="rounded"
-          paddingX={1}
-          paddingY={0}
-        >
-          <text fg={uiTheme.accent} attributes={TextAttributes.BOLD}>
-            ✓
-          </text>
-          <text fg={uiTheme.text} attributes={TextAttributes.BOLD}>
-            Copied
-          </text>
-        </box>
-      ) : null}
-    </box>
-  );
-};