📝 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)
## Source Study Docs
Try it here: https://cloud-code-study.vercel.app/
## Source Code Study Docs
Welcome to try it: https://cloud-code-study.vercel.app/
- https://github.com/Janlaywss/cloud-code-study
## Usage Guide
- This repository already contains the restored source code under `claude-code-source/`.
- For local build and run instructions, see `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.
- If you are using a different CPU architecture, adjust the installation yourself or let AI help you with it.
- The project root also contains an `ai-cloud-xxxx.tgz` archive, which is the original npm package for version `2.1.88`.
## How to Use
- The source code in this repository has already been restored. See the `claude-code-source` directory.
- How to compile and run it locally? Please refer to `claude-code-source/README.md`.
- My computer is a MacBook Pro with an Apple chip. So the Bun runtime architecture used there is adapted for Apple chips.
- For other CPU chip architectures, please figure out the installation yourself, or let AI handle it directly.
- 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
```bash
@@ -39,26 +39,26 @@ 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
```text
.
├── src/ # Core source code (1,902 files)
├── src/ # Core source code (1902 files)
│ ├── main.tsx # Application entry
│ ├── Tool.ts # Tool base class
│ ├── Task.ts # Task management
│ ├── QueryEngine.ts # Query engine
│ ├── commands.ts # Command registration
│ ├── tools.ts # Tool registration
│ ├── assistant/ # Conversation history management
│ ├── assistant/ # Session history management
│ ├── bootstrap/ # Startup initialization
│ ├── bridge/ # Bridge layer (31 files)
│ ├── buddy/ # Sub-agent system (6)
│ ├── cli/ # CLI argument parsing and entrypoints (19)
│ ├── commands/ # Slash command implementations (207)
│ ├── components/ # Terminal UI components built with Ink (389)
│ ├── cli/ # CLI parameter parsing and entry (19)
│ ├── commands/ # Slash command implementation (207)
│ ├── components/ # Terminal UI components, based on Ink (389)
│ ├── constants/ # Shared constants (21)
│ ├── context/ # Context management (9)
│ ├── coordinator/ # Agent coordinator (1)
@@ -69,10 +69,10 @@ The source map contains **4,756** source files with complete `sourcesContent`, w
│ ├── memdir/ # Memory directory system (8)
│ ├── migrations/ # Data migrations (11)
│ ├── moreright/ # Permission system (1)
│ ├── native-ts/ # Native TS tooling (4)
│ ├── native-ts/ # Native TS tools (4)
│ ├── outputStyles/ # Output formatting (1)
│ ├── plugins/ # Plugin system (2)
│ ├── query/ # Query handling (4)
│ ├── query/ # Query processing (4)
│ ├── remote/ # Remote execution (4)
│ ├── schemas/ # Data schema definitions (1)
│ ├── screens/ # Screen views (3)
@@ -81,43 +81,43 @@ The source map contains **4,756** source files with complete `sourcesContent`, w
│ ├── skills/ # Skill system (20)
│ ├── state/ # State management (6)
│ ├── tasks/ # Task execution (12)
│ ├── tools/ # Tool implementations (184)
│ ├── tools/ # Tool implementation (184)
│ ├── types/ # TypeScript type definitions (11)
│ ├── upstreamproxy/ # Upstream proxy support (2)
│ ├── utils/ # Utility functions (564)
│ ├── vim/ # Vim mode (5)
│ └── voice/ # Voice input (1)
├── 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
│ ├── audio-capture-src/ # Audio capture
│ └── 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 |
|------|--------|------|
| `utils/` | 564 | Utility functions for file I/O, Git operations, permission checks, diff handling, and more |
| `components/` | 389 | Terminal UI components built with Ink, the CLI equivalent of React |
| `commands/` | 207 | Slash command implementations such as `/commit` and `/review` |
| `tools/` | 184 | Agent tools including Read, Write, Edit, Bash, Glob, Grep, and more |
| `services/` | 130 | Core services such as API clients, auth, config, and session management |
| `hooks/` | 104 | Lifecycle hooks for interception and permission control around tool execution |
| `ink/` | 96 | A custom Ink rendering engine with layout, focus management, and render optimizations |
| `bridge/` | 31 | The bridge layer between IDE extensions and the CLI |
| `utils/` | 564 | Utility function set — file I/O, Git operations, permission checks, diff handling, etc. |
| `components/` | 389 | Terminal UI components, built based on Ink (the CLI version of React) |
| `commands/` | 207 | Slash command implementation, such as `/commit`, `/review`, etc. |
| `tools/` | 184 | Agent tool implementation — Read, Write, Edit, Bash, Glob, Grep, etc. |
| `services/` | 130 | Core services API client, authentication, configuration, session management, etc. |
| `hooks/` | 104 | Lifecycle hooks interception and permission control before and after tool execution |
| `ink/` | 96 | Self-developed Ink rendering engine, including layout, focus management, and rendering optimization |
| `bridge/` | 31 | Bridge layer — communication between IDE extensions and the CLI |
| `skills/` | 20 | Skill loading and execution system |
| `cli/` | 19 | CLI argument parsing and startup flow |
| `keybindings/` | 14 | Keyboard shortcut bindings and customization |
| `tasks/` | 12 | Background jobs and scheduled task management |
| `cli/` | 19 | CLI parameter parsing and startup logic |
| `keybindings/` | 14 | Keyboard shortcut binding and customization |
| `tasks/` | 12 | Background tasks and scheduled task management |
## Stats
| Metric | Value |
|------|------|
| 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 |
| Source map size | 57 MB |
| Package version | 2.1.88 |