mirror of
https://github.com/CherryHQ/cherry-studio.git
synced 2026-01-01 09:49:03 +08:00
58dbb514e0
- Added `aisdk-stream-protocel.md` to document text and data stream protocols. - Created `ClaudeCodeService` for invoking and streaming responses from the Claude Code CLI. - Introduced built-in tools for Claude Code, including Bash, Edit, and WebFetch. - Developed transformation functions to convert Claude Code messages to AI SDK format. - Enhanced OCR utility with delayed loading of the Sharp module. - Updated agent types and session message structures to accommodate new features. - Modified API tests to reflect changes in session creation and message streaming. - Upgraded `uuid` package to version 13.0.0 for improved UUID generation.
90 lines
3.6 KiB
Markdown
90 lines
3.6 KiB
Markdown
# AI Assistant Guide
|
|
|
|
This file provides guidance to AI coding assistants when working with code in this repository. Adherence to these guidelines is crucial for maintaining code quality and consistency.
|
|
|
|
## Guiding Principles
|
|
|
|
- **Clarity and Simplicity**: Write code that is easy to understand and maintain.
|
|
- **Consistency**: Follow existing patterns and conventions in the codebase.
|
|
- **Correctness**: Ensure code is correct, well-tested, and robust.
|
|
- **Efficiency**: Write performant code and use resources judiciously.
|
|
|
|
## MUST Follow Rules
|
|
|
|
1. **Code Search**: Use `ast-grep` for semantic code pattern searches when available. Fallback to `rg` (ripgrep) or `grep` for text-based searches.
|
|
2. **UI Framework**: Exclusively use **HeroUI** for all new UI components. The use of `antd` or `styled-components` is strictly **PROHIBITED**.
|
|
3. **Quality Assurance**: **Always** run `yarn build:check` before finalizing your work or making any commits. This ensures code quality (linting, testing, and type checking).
|
|
4. **Session Documentation**: MUST Consistently maintain the session SDLC log file following the template structure outlined in the Session Tracking section.
|
|
5. **Centralized Logging**: Use the `loggerService` exclusively for all application logging (info, warn, error levels) with proper context. Do not use `console.log`.
|
|
6. **External Research**: Leverage `subagent` for gathering external information, including latest documentation, API references, news, or web-based research. This keeps the main conversation focused on the task at hand.
|
|
|
|
## Session Tracking
|
|
|
|
ALWAYS maintain a session log in `.sessions/YYYY-MM-DD-HH-MM-SS-<feature>.md`. This is critical for tracking progress and decisions:
|
|
|
|
```md
|
|
# <feature> — SDLC Session (<YYYY-MM-DD HH:MM>)
|
|
|
|
## Design Brief
|
|
- Problem & goals:
|
|
- Non-goals/scope:
|
|
- Constraints & risks:
|
|
- Acceptance criteria:
|
|
|
|
## Solution Design
|
|
- Architecture/flow:
|
|
- Key interfaces:
|
|
- Data model:
|
|
- Test strategy:
|
|
|
|
## Work Plan
|
|
| ID | Task | Owner | Depends | Est | Status |
|
|
| --- | ---- | ----- | ------- | --- | ------ |
|
|
| T1 | | | | | TODO |
|
|
|
|
## Patch Log
|
|
### <HH:MM>
|
|
- Summary:
|
|
- Files:
|
|
- Tests/Commands:
|
|
- Next:
|
|
|
|
## Validation
|
|
- [ ] Criteria met
|
|
- [ ] build:check passes
|
|
- [ ] Tests green
|
|
```
|
|
|
|
|
|
## Development Commands
|
|
|
|
- **Install**: `yarn install`
|
|
- **Development**: `yarn dev` - Runs Electron app in development mode
|
|
- **Debug**: `yarn debug` - Starts with debugging enabled, use chrome://inspect
|
|
- **Build Check**: `yarn build:check` - REQUIRED before commits (lint + test + typecheck)
|
|
- **Test**: `yarn test` - Run all tests (Vitest)
|
|
- **Single Test**: `yarn test:main` or `yarn test:renderer`
|
|
- **Lint**: `yarn lint` - Fix linting issues and run typecheck
|
|
|
|
## Project Architecture
|
|
|
|
### Electron Structure
|
|
- **Main Process** (`src/main/`): Node.js backend with services (MCP, Knowledge, Storage, etc.)
|
|
- **Renderer Process** (`src/renderer/`): React UI with Redux state management
|
|
- **Preload Scripts** (`src/preload/`): Secure IPC bridge
|
|
|
|
### Key Components
|
|
- **AI Core** (`src/renderer/src/aiCore/`): Middleware pipeline for multiple AI providers.
|
|
- **Services** (`src/main/services/`): MCPService, KnowledgeService, WindowService, etc.
|
|
- **Build System**: Electron-Vite with experimental rolldown-vite, yarn workspaces.
|
|
- **State Management**: Redux Toolkit (`src/renderer/src/store/`) for predictable state.
|
|
- **UI Components**: HeroUI (`@heroui/*`) for all new UI elements.
|
|
|
|
### Logging
|
|
```typescript
|
|
import { loggerService } from '@logger'
|
|
const logger = loggerService.withContext('moduleName')
|
|
// Renderer: loggerService.initWindowSource('windowName') first
|
|
logger.info('message', CONTEXT)
|
|
```
|