dimcode 0.0.5 → 0.0.6-beta.2

package/README.md

@@ -1,18 +1,46 @@
+<img src="https://storage-static.fazhiplus.com/zmchat-avatar/0752d736887697a3284138d013052e53+MjI1ZWM1YTAtNmE4Zi00ZWRkLWI0NjktZjNlNzM4N2U0M2M3LjBkZDI2ODc1LWYxMGYtNDBhNC05NWQ1LWJiZGY2ZmEwM2M0OXgxNzY5NzQ4MDM4MTcyNDEwNzYw" alt="Brand Logo" height="100">
+
 # Dimcode CLI
 
-> A powerful AI agent CLI built on GoatChain with an interactive terminal UI (TUI)
+> A powerful AI agent CLI with a beautiful interactive terminal UI (TUI)
 
 [![npm version](https://badge.fury.io/js/dimcode.svg)](https://badge.fury.io/js/dimcode)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-Dimcode is a command-line interface for AI-powered coding assistance, featuring:
+Dimcode is a command-line interface for AI-powered coding assistance. It helps you move fast with:
 
 - 🎨 **Beautiful TUI** - Modern terminal interface built with Vue 3
-- 💬 **Multi-session Management** - Manage multiple AI conversations
-- 🔧 **Built-in Tools** - File operations, web search, code analysis
-- ⚡ **Streaming Responses** - Real-time AI response streaming
-- 🎯 **Tool Approvals** - Fine-grained control over tool execution
-- 🌈 **Themes** - Customizable color schemes
+- 💬 **Multi-session Management** - Organize multiple AI conversations
+- 🔧 **Built-in Tools** - File ops, web search, code analysis, and more
+- ⚡ **Streaming Responses** - See AI outputs in real time
+- 🎯 **Tool Approvals** - Granular control over tool execution
+- 🌈 **Themes** - Flexible, customizable color schemes
+
+## 📈 Download Stats
+
+| Metric           | Live Badge                                                                                               |
+| ---------------- | -------------------------------------------------------------------------------------------------------- |
+| Weekly downloads | [![npm downloads (week)](https://img.shields.io/npm/dw/dimcode)](https://www.npmjs.com/package/dimcode)  |
+| Total downloads  | [![npm downloads (total)](https://img.shields.io/npm/dt/dimcode)](https://www.npmjs.com/package/dimcode) |
+
+## ⚡ Get Started in 30 Seconds
+
+1. Install the CLI
+
+```bash
+npm install -g dimcode
+```
+
+2. Run it
+
+```bash
+dim
+```
+
+3. Ask for help
+
+```text
+Create a React component for a todo list
+```
 
 ## 📦 Installation
 
@@ -43,16 +71,6 @@ Run directly without installation:
 npx dimcode
 ```
 
-## 🚀 Quick Start
-
-After installation, simply run:
-
-```bash
-dim
-```
-
-This will launch the interactive terminal UI.
-
 ## 🎮 Usage
 
 ### Command Palette
@@ -69,22 +87,37 @@ Press `Ctrl+P` to open the command palette, which provides quick access to:
 
 Type slash commands directly in the input field:
 
-| Command | Description |
-|---------|-------------|
-| `/settings` | Open settings dialog |
-| `/approvals` | Manage tool approvals |
-| `/sessions` | List all sessions |
-| `/new` | Create a new session |
-| `/redo` | Redo last interaction (Chat view only) |
+| Command           | Description                             |
+| ----------------- | --------------------------------------- |
+| `/settings`       | Open settings dialog (custom providers) |
+| `/config`         | Alternative for `/settings`             |
+| `/approvals`      | Manage tool approvals (auto/all)        |
+| `/approval`       | Alternative for `/approvals`            |
+| `/connect`        | Connect a provider                      |
+| `/models`         | Select a model                          |
+| `/sessions`       | List all sessions                       |
+| `/new`            | Create a new session                    |
+| `/redo`           | Redo last interaction                   |
+| `/rename <title>` | Rename current session                  |
+| `/timeline`       | Jump to a user message                  |
+| `/tl`             | Alternative for `/timeline`             |
+| `/review`         | Review code changes                     |
+| `/debug`          | Open debug dialog (node mode only)      |
 
 ### Keyboard Shortcuts
 
-| Shortcut | Action |
-|----------|--------|
-| `Ctrl+P` | Open command palette |
-| `Ctrl+C` | Exit the application |
-| `Enter` | Send message |
-| `Shift+Enter` | New line in input |
+| Shortcut      | Action                                     |
+| ------------- | ------------------------------------------ |
+| `Ctrl+P`      | Open command palette                       |
+| `Ctrl+C`      | Clear input (if non-empty); otherwise exit |
+| `Enter`       | Send message                               |
+| `Shift+Enter` | New line in input                          |
+
+### Input Tips
+
+- Drag to select text, then release to auto-copy (when enabled)
+- In the input area, use `Shift+Option` for rectangular selection
+- Triple-click in the input area to select all
 
 ## ⚙️ Configuration
 
@@ -96,7 +129,7 @@ Create a `.env` file in your working directory or set environment variables:
 # OpenAI Configuration
 OPENAI_API_KEY=your_api_key_here
 OPENAI_BASE_URL=https://api.openai.com/v1  # Optional
-MODEL_ID=gpt-4o  # Default model
+DIMCODE_MODEL=deepseek-v3.1  # Default model
 
 # Serper API for web search (optional)
 SERPER_API_KEY=your_serper_key_here
@@ -110,33 +143,38 @@ On first launch, Dimcode will guide you through:
 2. **Model Selection** - Choose your preferred AI model
 3. **Tool Approvals** - Configure which tools can run automatically
 
-Settings are stored in `~/.goatchain/goatchain/` directory by default (can be customized via `GOATCHAIN_HOME` environment variable).
+Settings are stored in `~/.dimcode/dimcode/` directory by default (can be customized via `DIMCODE_HOME` environment variable).
 
 ## 🔧 Built-in Tools
 
 Dimcode comes with powerful built-in tools:
 
 ### File Operations
+
 - **Read** - Read file contents
 - **Write** - Create or overwrite files
 - **Edit** - Make precise edits to existing files
 
 ### Code Analysis
+
 - **Grep** - Search content using patterns
 - **Glob** - Find files by pattern
 - **AstGrepSearch** - AST-based code search
 - **AstGrepReplace** - AST-based code refactoring
 
 ### Web & Research
+
 - **WebSearch** - Search the web using Serper API
 - **WebFetch** - Fetch web page content
 
 ### Task Management
+
 - **TodoWrite** - Create and manage TODO lists
 - **Task** - Execute complex multi-step tasks
 - **Skill** - Store and reuse common workflows
 
 ### System
+
 - **Bash** - Execute shell commands (requires approval)
 - **AskUser** - Request input from user
 
@@ -166,5 +204,4 @@ dim
 ## 🔐 Security & Privacy
 
 - **Tool Approvals**: By default, sensitive operations (file writes, shell commands) require user approval
-- **Local Storage**: All session data is stored locally in `~/.goatchain/goatchain/` (customizable via `GOATCHAIN_HOME`)
-
+- **Local Storage**: All session data is stored locally in `~/.dimcode/dimcode/` (customizable via `DIMCODE_HOME`)