deplyze-code 0.1.0 → 0.1.3

package/README.en.md

@@ -1,210 +1,161 @@
-# Deplyze Code
-
-<p align="right"><a href="./README.md">中文</a> | <strong>English</strong></p>
-
-Deplyze Code is a Gemini-powered terminal coding assistant with the original-style Ink TUI and REPL preserved.
-
-> This repository keeps the working terminal UI and command flow intact while routing the active runtime through the Gemini API-key path.
-
-<p align="center">
-  <img src="docs/00runtime.png" alt="Runtime screenshot" width="800">
-</p>
-
-## Features
-
-- Full Ink TUI and interactive REPL
-- `--print` headless mode for scripts and CI
-- Slash commands, tools, MCP, plugins, and Skills
-- Gemini model switching through `/model`
-- Fallback Recovery CLI mode
-
----
-
-## Quick Start
-
-### 1. Install Bun
-
-This project requires [Bun](https://bun.sh).
-
-```bash
-# macOS / Linux
-curl -fsSL https://bun.sh/install | bash
-```
-
-```bash
-# macOS (Homebrew)
-brew install bun
-```
-
-```powershell
-# Windows (PowerShell)
-powershell -c "irm bun.sh/install.ps1 | iex"
-```
-
-Verify the installation:
-
-```bash
-bun --version
-```
-
-### 2. Install Dependencies
-
-```bash
-bun install
-```
-
-### 3. Configure Environment Variables
-
-Copy the example file:
-
-```bash
-cp .env.example .env
-```
-
-Set at least:
-
-```env
-GEMINI_API_KEY=your_api_key_here
-```
-
-Optional:
-
-```env
-GEMINI_MODEL=gemini-3.1-pro-preview
-GEMINI_SMALL_FAST_MODEL=gemini-3.1-flash-lite-preview
-DISABLE_TELEMETRY=1
-CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC=1
-```
-
-### 4. Run Locally From Source
-
-#### macOS / Linux
-
-```bash
-./bin/deplyze
-```
-
-```bash
-./bin/deplyze -p "hello"
-```
-
-```bash
-echo "inspect this repository" | ./bin/deplyze -p
-```
-
-```bash
-./bin/deplyze --help
-```
-
-#### Windows
-
-```powershell
-bun ./bin/deplyze
-```
-
-```powershell
-bun ./bin/deplyze -p "hello"
-```
-
-```powershell
-bun ./bin/deplyze --help
-```
-
-### 5. Install Globally
-
-```bash
-npm install -g deplyze-code
-```
-
-Then run:
-
-```bash
-deplyze
-```
-
----
-
-## Environment Variables
-
-| Variable | Required | Description |
-|------|------|------|
-| `GEMINI_API_KEY` | Yes | Gemini API key used by the normal interactive runtime |
-| `GEMINI_MODEL` | No | Default main model override |
-| `GEMINI_SMALL_FAST_MODEL` | No | Fast verification / low-cost model override |
-| `DISABLE_TELEMETRY` | No | Set to `1` to disable telemetry |
-| `CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC` | No | Set to `1` to disable non-essential network traffic |
-
----
-
-## Models
-
-The active `/model` flow exposes:
-
-- `Gemini 3.1 Pro`
-- `Gemini 3 Flash`
-- `Gemini 3.1 Flash-Lite`
-
-The runtime uses the current Gemini API handles underneath:
-
-- `gemini-3.1-pro-preview`
-- `gemini-3-flash-preview`
-- `gemini-3.1-flash-lite-preview`
-
----
-
-## Fallback Mode
-
-If the full TUI has issues, use the simplified recovery CLI:
-
-```bash
-CLAUDE_CODE_FORCE_RECOVERY_CLI=1 ./bin/deplyze
-```
-
-On Windows PowerShell:
-
-```powershell
-$env:CLAUDE_CODE_FORCE_RECOVERY_CLI='1'
-bun ./bin/deplyze
-```
-
----
-
-## Project Structure
-
-```text
-bin/deplyze              # Release entry script
-preload.ts               # Bun preload (sets MACRO globals)
-.env.example             # Environment variable template
-src/
-├── entrypoints/cli.tsx  # Main CLI entry
-├── main.tsx             # Main TUI logic (Commander.js + React/Ink)
-├── localRecoveryCli.ts  # Fallback Recovery CLI
-├── screens/REPL.tsx     # Interactive REPL screen
-├── components/          # UI components
-├── commands/            # Slash commands
-├── tools/               # Agent tools (Bash, Edit, Grep, etc.)
-├── services/            # Service layer
-├── hooks/               # React hooks
-└── utils/               # Utility functions
-```
-
----
-
-## Tech Stack
-
-| Category | Technology |
-|------|------|
-| Runtime | [Bun](https://bun.sh) |
-| Language | TypeScript |
-| Terminal UI | React + [Ink](https://github.com/vadimdemedes/ink) |
-| CLI parsing | Commander.js |
-| API | Gemini via [`@google/genai`](https://www.npmjs.com/package/@google/genai) |
-| Protocols | MCP, LSP |
-
----
-
-## Notes
-
-- The active runtime uses API-key auth only for now.
-- Legacy login and onboarding code remains in the repository but is not required for normal Gemini usage.
-- The `CLAUDE.md` filename is intentionally unchanged for compatibility.
+# Deplyze Code
+
+Deplyze Code is a Gemini-powered terminal coding assistant with an interactive Ink TUI, REPL, tools, and slash commands.
+
+This package is intended to be installed globally and started with:
+
+```bash
+deplyze
+```
+
+## Status
+
+- Current private release: `0.1.3`
+- Active auth path: Gemini API key
+- Active model picker: Gemini 3.1 Pro, Gemini 3 Flash, Gemini 3.1 Flash-Lite
+- `CLAUDE.md` remains the repository guidance filename for compatibility
+
+## Install
+
+Install Bun first if it is not already available:
+
+```bash
+curl -fsSL https://bun.sh/install | bash
+```
+
+```powershell
+powershell -c "irm bun.sh/install.ps1 | iex"
+```
+
+Install the package globally:
+
+```bash
+npm install -g deplyze-code
+```
+
+## Required Environment Variable
+
+Set your Gemini API key:
+
+```bash
+export GEMINI_API_KEY="your_api_key_here"
+```
+
+PowerShell:
+
+```powershell
+$env:GEMINI_API_KEY="your_api_key_here"
+```
+
+Optional:
+
+```bash
+export GEMINI_MODEL="gemini-3.1-pro-preview"
+export GEMINI_SMALL_FAST_MODEL="gemini-3.1-flash-lite-preview"
+```
+
+## Start
+
+Run:
+
+```bash
+deplyze
+```
+
+On first launch with `GEMINI_API_KEY` set, Deplyze Code should open directly into the main REPL without the legacy onboarding flow.
+
+## If `deplyze` Is Not Found
+
+If global install succeeds but the shell says `deplyze` is not recognized, your npm global bin directory is probably not on `PATH`.
+
+Check the prefix:
+
+```bash
+npm prefix -g
+```
+
+Make sure the corresponding global bin directory is on your shell `PATH`, then reopen the terminal.
+
+## Basic Usage
+
+Plain interactive launch:
+
+```bash
+deplyze
+```
+
+Single prompt:
+
+```bash
+deplyze -p "hello"
+```
+
+Repository question:
+
+```bash
+deplyze -p "Inspect this repository and tell me what file launches the REPL."
+```
+
+Bash tool example:
+
+```bash
+deplyze -p "Use the Bash tool to print the current working directory, then answer with only that path." --allowedTools Bash --dangerously-skip-permissions
+```
+
+## Model Switching
+
+Inside the interactive UI, run:
+
+```text
+/model
+```
+
+Available models in the active UI:
+
+- `Gemini 3.1 Pro`
+- `Gemini 3 Flash`
+- `Gemini 3.1 Flash-Lite`
+
+Underlying Gemini API model handles:
+
+- `gemini-3.1-pro-preview`
+- `gemini-3-flash-preview`
+- `gemini-3.1-flash-lite-preview`
+
+## What This Release Uses
+
+- Provider flow: Gemini API key
+- Required auth for normal usage: `GEMINI_API_KEY`
+- UI flow: existing Deplyze Code TUI and REPL
+- Legacy login and OAuth code still exists in the repository, but it is not required for the standard Gemini path
+
+## Source Checkout Usage
+
+If you are running from a local checkout instead of a global install:
+
+```bash
+bun install
+./bin/deplyze
+```
+
+Windows:
+
+```powershell
+bun install
+bun ./bin/deplyze
+```
+
+## Recovery Mode
+
+If you need the simplified recovery CLI:
+
+```bash
+CLAUDE_CODE_FORCE_RECOVERY_CLI=1 deplyze
+```
+
+PowerShell:
+
+```powershell
+$env:CLAUDE_CODE_FORCE_RECOVERY_CLI='1'
+deplyze
+```