📝 docs(repo): align english readme to source text

This commit is contained in:
墨綠BG
2026-04-01 12:35:51 +08:00
parent 7e2d147d30
commit b3417e54f8

View File

@@ -1,17 +1,17 @@
# Cloud-code Restored Source # Cloud-code Cracked Version
English | [简体中文](./README.md) English | [简体中文](./README.md)
## Source Study Docs ## Source Code Study Docs
Try it here: https://cloud-code-study.vercel.app/ Welcome to try it: https://cloud-code-study.vercel.app/
- https://github.com/Janlaywss/cloud-code-study - https://github.com/Janlaywss/cloud-code-study
## Usage Guide ## How to Use
- This repository already contains the restored source code under `claude-code-source/`. - The source code in this repository has already been restored. See the `claude-code-source` directory.
- For local build and run instructions, see `claude-code-source/README.md`. - How to compile and run it locally? Please refer to `claude-code-source/README.md`.
- The original setup was tested on a MacBook Pro with Apple silicon, so the Bun runtime there is configured for Apple chips. - My computer is a MacBook Pro with an Apple chip. So the Bun runtime architecture used there is adapted for Apple chips.
- If you are using a different CPU architecture, adjust the installation yourself or let AI help you with it. - For other CPU chip architectures, please figure out the installation yourself, or let AI handle it directly.
- The project root also contains an `ai-cloud-xxxx.tgz` archive, which is the original npm package for version `2.1.88`. - There is an `ai-cloud-xxxx.tgz` file in the root directory. This is the original npm package for 2188.
## Restoration Method Used in This Repository ## Restoration Method Used in This Repository
```bash ```bash
@@ -39,40 +39,40 @@ for (let i = 0; i < map.sources.length; i++) {
" "
``` ```
The source map contains **4,756** source files with complete `sourcesContent`, which makes it possible to restore every original TypeScript/TSX file losslessly. The source map contains **4756** source files and their complete source code (`sourcesContent`), which can restore all original TypeScript/TSX code without loss.
## Directory Structure ## Directory Structure
```text ```text
. .
├── src/ # Core source code (1,902 files) ├── src/ # Core source code (1902 files)
│ ├── main.tsx # Application entry │ ├── main.tsx # Application entry
│ ├── Tool.ts # Tool base class │ ├── Tool.ts # Tool base class
│ ├── Task.ts # Task management │ ├── Task.ts # Task management
│ ├── QueryEngine.ts # Query engine │ ├── QueryEngine.ts # Query engine
│ ├── commands.ts # Command registration │ ├── commands.ts # Command registration
│ ├── tools.ts # Tool registration │ ├── tools.ts # Tool registration
│ ├── assistant/ # Conversation history management │ ├── assistant/ # Session history management
│ ├── bootstrap/ # Startup initialization │ ├── bootstrap/ # Startup initialization
│ ├── bridge/ # Bridge layer (31 files) │ ├── bridge/ # Bridge layer (31 files)
│ ├── buddy/ # Sub-agent system (6) │ ├── buddy/ # Sub-agent system (6)
│ ├── cli/ # CLI argument parsing and entrypoints (19) │ ├── cli/ # CLI parameter parsing and entry (19)
│ ├── commands/ # Slash command implementations (207) │ ├── commands/ # Slash command implementation (207)
│ ├── components/ # Terminal UI components built with Ink (389) │ ├── components/ # Terminal UI components, based on Ink (389)
│ ├── constants/ # Shared constants (21) │ ├── constants/ # Shared constants (21)
│ ├── context/ # Context management (9) │ ├── context/ # Context management (9)
│ ├── coordinator/ # Agent coordinator (1) │ ├── coordinator/ # Agent coordinator (1)
│ ├── entrypoints/ # Various entrypoints (8) │ ├── entrypoints/ # Various entry points (8)
│ ├── hooks/ # Lifecycle hooks (104) │ ├── hooks/ # Lifecycle hooks (104)
│ ├── ink/ # Custom Ink terminal rendering engine (96) │ ├── ink/ # Custom Ink terminal rendering engine (96)
│ ├── keybindings/ # Shortcut key management (14) │ ├── keybindings/ # Shortcut key management (14)
│ ├── memdir/ # Memory directory system (8) │ ├── memdir/ # Memory directory system (8)
│ ├── migrations/ # Data migrations (11) │ ├── migrations/ # Data migrations (11)
│ ├── moreright/ # Permission system (1) │ ├── moreright/ # Permission system (1)
│ ├── native-ts/ # Native TS tooling (4) │ ├── native-ts/ # Native TS tools (4)
│ ├── outputStyles/ # Output formatting (1) │ ├── outputStyles/ # Output formatting (1)
│ ├── plugins/ # Plugin system (2) │ ├── plugins/ # Plugin system (2)
│ ├── query/ # Query handling (4) │ ├── query/ # Query processing (4)
│ ├── remote/ # Remote execution (4) │ ├── remote/ # Remote execution (4)
│ ├── schemas/ # Data schema definitions (1) │ ├── schemas/ # Data schema definitions (1)
│ ├── screens/ # Screen views (3) │ ├── screens/ # Screen views (3)
@@ -81,43 +81,43 @@ The source map contains **4,756** source files with complete `sourcesContent`, w
│ ├── skills/ # Skill system (20) │ ├── skills/ # Skill system (20)
│ ├── state/ # State management (6) │ ├── state/ # State management (6)
│ ├── tasks/ # Task execution (12) │ ├── tasks/ # Task execution (12)
│ ├── tools/ # Tool implementations (184) │ ├── tools/ # Tool implementation (184)
│ ├── types/ # TypeScript type definitions (11) │ ├── types/ # TypeScript type definitions (11)
│ ├── upstreamproxy/ # Upstream proxy support (2) │ ├── upstreamproxy/ # Upstream proxy support (2)
│ ├── utils/ # Utility functions (564) │ ├── utils/ # Utility functions (564)
│ ├── vim/ # Vim mode (5) │ ├── vim/ # Vim mode (5)
│ └── voice/ # Voice input (1) │ └── voice/ # Voice input (1)
├── vendor/ # Internal vendor code (4 files) ├── vendor/ # Internal vendor code (4 files)
│ ├── modifiers-napi-src/ # Native key modifier module │ ├── modifiers-napi-src/ # Native module for key modifiers
│ ├── url-handler-src/ # URL handling │ ├── url-handler-src/ # URL handling
│ ├── audio-capture-src/ # Audio capture │ ├── audio-capture-src/ # Audio capture
│ └── image-processor-src/ # Image processing │ └── image-processor-src/ # Image processing
└── node_modules/ # Bundled third-party dependencies (2,850 files) └── node_modules/ # Packaged third-party dependencies (2850 files)
``` ```
## Core Module Overview ## Core Module Description
| Module | File Count | Description | | Module | File Count | Description |
|------|--------|------| |------|--------|------|
| `utils/` | 564 | Utility functions for file I/O, Git operations, permission checks, diff handling, and more | | `utils/` | 564 | Utility function set — file I/O, Git operations, permission checks, diff handling, etc. |
| `components/` | 389 | Terminal UI components built with Ink, the CLI equivalent of React | | `components/` | 389 | Terminal UI components, built based on Ink (the CLI version of React) |
| `commands/` | 207 | Slash command implementations such as `/commit` and `/review` | | `commands/` | 207 | Slash command implementation, such as `/commit`, `/review`, etc. |
| `tools/` | 184 | Agent tools including Read, Write, Edit, Bash, Glob, Grep, and more | | `tools/` | 184 | Agent tool implementation — Read, Write, Edit, Bash, Glob, Grep, etc. |
| `services/` | 130 | Core services such as API clients, auth, config, and session management | | `services/` | 130 | Core services API client, authentication, configuration, session management, etc. |
| `hooks/` | 104 | Lifecycle hooks for interception and permission control around tool execution | | `hooks/` | 104 | Lifecycle hooks interception and permission control before and after tool execution |
| `ink/` | 96 | A custom Ink rendering engine with layout, focus management, and render optimizations | | `ink/` | 96 | Self-developed Ink rendering engine, including layout, focus management, and rendering optimization |
| `bridge/` | 31 | The bridge layer between IDE extensions and the CLI | | `bridge/` | 31 | Bridge layer — communication between IDE extensions and the CLI |
| `skills/` | 20 | Skill loading and execution system | | `skills/` | 20 | Skill loading and execution system |
| `cli/` | 19 | CLI argument parsing and startup flow | | `cli/` | 19 | CLI parameter parsing and startup logic |
| `keybindings/` | 14 | Keyboard shortcut bindings and customization | | `keybindings/` | 14 | Keyboard shortcut binding and customization |
| `tasks/` | 12 | Background jobs and scheduled task management | | `tasks/` | 12 | Background tasks and scheduled task management |
## Stats ## Stats
| Metric | Value | | Metric | Value |
|------|------| |------|------|
| Total source files | 4,756 | | Total source files | 4,756 |
| Core source (`src/ + vendor/`) | 1,906 files | | Core source code (`src/ + vendor/`) | 1,906 files |
| Third-party dependencies (`node_modules/`) | 2,850 files | | Third-party dependencies (`node_modules/`) | 2,850 files |
| Source map size | 57 MB | | Source map size | 57 MB |
| Package version | 2.1.88 | | Package version | 2.1.88 |