Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
99 changes: 51 additions & 48 deletions README.jp.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@
<a href="https://github.com/ThinkInAIXYZ/deepchat/issues"><img src="https://img.shields.io/github/issues/ThinkInAIXYZ/deepchat" alt="Issues Badge"/></a>
<a href="https://github.com/ThinkInAIXYZ/deepchat/blob/main/LICENSE"><img src="https://img.shields.io/github/license/ThinkInAIXYZ/deepchat" alt="License Badge"/></a>
<a href="https://github.com/ThinkInAIXYZ/deepchat/releases/latest"><img src="https://img.shields.io/endpoint?url=https://api.pinstudios.net/api/badges/downloads/ThinkInAIXYZ/deepchat/total" alt="Downloads"></a>
<a href="https://deepwiki.com/ThinkInAIXYZ/deepchat"><img src="https://deepwiki.com/badge.svg" alt="Ask DeepWiki"></a>
</p>

<div align="center">
Expand Down Expand Up @@ -65,6 +64,10 @@
- [📑 目次](#-目次)
- [🚀 プロジェクト紹介](#-プロジェクト紹介)
- [💡 なぜDeepChatを選ぶのか](#-なぜdeepchatを選ぶのか)
- [📦 クイックスタート](#-クイックスタート)
- [ダウンロードとインストール](#ダウンロードとインストール)
- [モデルの設定](#モデルの設定)
- [会話を開始](#会話を開始)
- [🔥 主な機能](#-主な機能)
- [📼 Tape と Trace](#-tape-と-trace)
- [🧠 Skills サポート](#-skills-サポート)
Expand All @@ -73,10 +76,6 @@
- [🤖 サポートされているモデルプロバイダー](#-サポートされているモデルプロバイダー)
- [OpenAI/Gemini/Anthropic API形式の任意のモデルプロバイダーと互換性あり](#openaigeminianthropic-api形式の任意のモデルプロバイダーと互換性あり)
- [🔍 ユースケース](#-ユースケース)
- [📦 クイックスタート](#-クイックスタート)
- [ダウンロードとインストール](#ダウンロードとインストール)
- [モデルの設定](#モデルの設定)
- [会話を開始](#会話を開始)
- [💻 開発ガイド](#-開発ガイド)
- [依存関係のインストール](#依存関係のインストール)
- [開発を開始](#開発を開始)
Expand Down Expand Up @@ -119,6 +118,45 @@ DeepChatのセッションとAgentプロセスはTape.systemsの哲学に基づ
- **プライバシー重視**: ローカルデータストレージとネットワークプロキシのサポートにより、情報漏洩のリスクを軽減します
- **ビジネスフレンドリー**: Apache License 2.0の下でオープンソース化され、商用・個人利用の両方に適しています

## 📦 クイックスタート

### ダウンロードとインストール

以下のいずれかの方法で DeepChat をインストールできます:

**方法1:GitHub Releases**

[GitHub Releases](https://github.com/ThinkInAIXYZ/deepchat/releases)ページからお使いのシステム用の最新バージョンをダウンロードしてください:

- Windows: `.exe`インストールファイル
- macOS: `.dmg`インストールファイル
- Linux: `.AppImage`または`.deb`インストールファイル

**方法2:公式ウェブサイト**

[公式ウェブサイト](https://deepchatai.cn/#/download)からダウンロードできます。

**方法3:Homebrew(macOS のみ)**

macOS ユーザーは Homebrew を使用してインストールできます:

```bash
brew install --cask deepchat
```

### モデルの設定

1. DeepChatアプリケーションを起動
2. 設定アイコンをクリック
3. "モデルプロバイダー"タブを選択
4. APIキーを追加するか、ローカルOllamaを設定

### 会話を開始

1. "+"ボタンをクリックして新しい会話を作成
2. 使用したいモデルを選択
3. AIアシスタントとの対話を開始

## 🔥 主な機能

- 🤖 **ローカルファーストAgentデスクトップクライアント**
Expand Down Expand Up @@ -149,13 +187,13 @@ DeepChatのセッションとAgentプロセスはTape.systemsの哲学に基づ
- 画像、Mermaidダイアグラム、その他のマルチモーダルコンテンツのレンダリングをサポート。GPT-4o、Gemini、Grokのテキストから画像生成機能をサポート
- 検索結果などの外部情報ソースをコンテンツ内でハイライト表示
- 🔍 **強力な検索強化機能**
- 博查搜索、Brave Searchなどの主要な検索APIを組み込み、モデルが検索のタイミングを賢く判断
- Bocha Search、Brave Searchなどの主要な検索APIを統合し、モデルが検索のタイミングを賢く判断
- ユーザーのウェブブラウジングをシミュレートすることで、Google、Bing、Baidu、Sogou公式アカウント検索などの主要検索エンジンをサポート
- あらゆる検索エンジンの読み取りをサポート。検索アシスタントモデルを設定するだけで、内部ネットワーク、APIなしのエンジン、垂直ドメイン検索エンジンなど、様々な情報ソースをモデルに接続可能
- 🔧 **優れたMCP(Model Context Protocol)サポート**
- Resources / Prompts / Tools の三大コア機能をサポート
- StreamableHTTP、SSE、StdioなどのTransportに対応
- 組み込みNode.jsランタイムにより、npx/node系サービスがすぐに利用可能
- npx/node系サービス向けの公式Node.jsツールチェーンを、必要なときに設定からインストール可能
- コード実行、Web情報取得、ファイル操作などのinMemoryサービスに対応
- ツール呼び出し、パラメータ、戻り値を見やすくデバッグ可能
- DeepLinkによるMCPサービスのワンクリックインストールに対応
Expand All @@ -180,7 +218,7 @@ DeepChat Skills は標準の Agent Skills 仕様と互換性のある設計で

Skillsはフォルダー、ZIPファイル、URLからインストールできます。Claude Code、Codex、Cursor、Windsurf、GitHub Copilot、Kiro、Antigravity、OpenCode、Goose、Kilo Code などの互換ツールとのインポート/エクスポートにも対応します。

組み込みSkillsは、生成アート、コードレビュー、DeepChat設定、ドキュメント共同作成、DOCX、フロントエンド設計、git commitメッセージ、インフォグラフィック構文、MCP構築、PDF、PPTX、Skill作成、Web Artifacts、XLSXワークフローをカバーします。
組み込みSkillsは、アルゴリズムアート、コードレビュー、DeepChat CLI、DeepChat設定、ドキュメント共同作成、DOCX、フロントエンド設計、git commitメッセージ、インフォグラフィック構文、MCP構築、メモリ管理、PDF、PPTX、Skill作成、XLSXワークフローをカバーします。

クイックスタート:

Expand Down Expand Up @@ -424,6 +462,8 @@ DeepChatはメッセージアプリからリモート操作できるため、デ

### OpenAI/Gemini/Anthropic API形式の任意のモデルプロバイダーと互換性あり

上記の組み込みプロバイダーに加えて、OpenAI、Gemini、Anthropic API形式と互換性のある任意のサービスをカスタムプロバイダーとして追加できます。

## 🔍 ユースケース

DeepChatは様々なAIアプリケーションシナリオに適しています:
Expand All @@ -434,45 +474,6 @@ DeepChatは様々なAIアプリケーションシナリオに適しています
- **コンテンツ作成**: コピーライティング、クリエイティブなインスピレーション、コンテンツの最適化
- **データ分析**: データの解釈、チャート生成、レポート作成

## 📦 クイックスタート

### ダウンロードとインストール

以下のいずれかの方法で DeepChat をインストールできます:

**方法1:GitHub Releases**

[GitHub Releases](https://github.com/ThinkInAIXYZ/deepchat/releases)ページからお使いのシステム用の最新バージョンをダウンロードしてください:

- Windows: `.exe`インストールファイル
- macOS: `.dmg`インストールファイル
- Linux: `.AppImage`または`.deb`インストールファイル

**方法2:公式ウェブサイト**

[公式ウェブサイト](https://deepchatai.cn/#/download)からダウンロードできます。

**方法3:Homebrew(macOS のみ)**

macOS ユーザーは Homebrew を使用してインストールできます:

```bash
brew install --cask deepchat
```

### モデルの設定

1. DeepChatアプリケーションを起動
2. 設定アイコンをクリック
3. "モデルプロバイダー"タブを選択
4. APIキーを追加するか、ローカルOllamaを設定

### 会話を開始

1. "+"ボタンをクリックして新しい会話を作成
2. 使用したいモデルを選択
3. AIアシスタントとの対話を開始

## 💻 開発ガイド

[貢献ガイドライン](./CONTRIBUTING.md)をお読みください。
Expand Down Expand Up @@ -518,6 +519,8 @@ $ pnpm run build:linux:x64
$ pnpm run build:linux:arm64
```

開発環境、プロジェクト構成、アーキテクチャの詳細は[開発者ガイド](./docs/guides/getting-started.md)と[ドキュメント索引](./docs/README.md)を参照してください。

## 👥 コミュニティと貢献

DeepChatはアクティブなオープンソースコミュニティプロジェクトであり、様々な形での貢献を歓迎します:
Expand All @@ -526,7 +529,7 @@ DeepChatはアクティブなオープンソースコミュニティプロジェ
- 💡 [機能の提案を提出する](https://github.com/ThinkInAIXYZ/deepchat/issues)
- 🔧 [コードの改善を提出する](https://github.com/ThinkInAIXYZ/deepchat/pulls)
- 📚 [ドキュメントを改善する](https://github.com/ThinkInAIXYZ/deepchat/wiki)
- 🌍 [翻訳を手伝う](https://github.com/ThinkInAIXYZ/deepchat/tree/main/locales)
- 🌍 [翻訳を手伝う](https://github.com/ThinkInAIXYZ/deepchat/tree/main/src/renderer/src/i18n)

プロジェクトへの参加方法について詳しく知るには、[貢献ガイドライン](./CONTRIBUTING.md)をご確認ください。

Expand Down
101 changes: 49 additions & 52 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@
<a href="https://github.com/ThinkInAIXYZ/deepchat/issues"><img src="https://img.shields.io/github/issues/ThinkInAIXYZ/deepchat" alt="Issues Badge"/></a>
<a href="https://github.com/ThinkInAIXYZ/deepchat/blob/main/LICENSE"><img src="https://img.shields.io/github/license/ThinkInAIXYZ/deepchat" alt="License Badge"/></a>
<a href="https://github.com/ThinkInAIXYZ/deepchat/releases/latest"><img src="https://img.shields.io/endpoint?url=https://api.pinstudios.net/api/badges/downloads/ThinkInAIXYZ/deepchat/total" alt="Downloads"></a>
<a href="https://deepwiki.com/ThinkInAIXYZ/deepchat"><img src="https://deepwiki.com/badge.svg" alt="Ask DeepWiki"></a>
</p>

<div align="center">
Expand Down Expand Up @@ -64,6 +63,10 @@
- [📑 Table of Contents](#-table-of-contents)
- [🚀 Project Introduction](#-project-introduction)
- [💡 Why Choose DeepChat](#-why-choose-deepchat)
- [📦 Quick Start](#-quick-start)
- [Download and Install](#download-and-install)
- [Configure Models](#configure-models)
- [Start Conversations](#start-conversations)
- [🔥 Main Features](#-main-features)
- [📼 Tape & Trace](#-tape--trace)
- [🧠 Skills Support](#-skills-support)
Expand All @@ -72,10 +75,6 @@
- [🤖 Supported Model Providers](#-supported-model-providers)
- [Compatible with any model provider in OpenAI/Gemini/Anthropic API format](#compatible-with-any-model-provider-in-openaigeminianthropic-api-format)
- [🔍 Use Cases](#-use-cases)
- [📦 Quick Start](#-quick-start)
- [Download and Install](#download-and-install)
- [Configure Models](#configure-models)
- [Start Conversations](#start-conversations)
- [💻 Development Guide](#-development-guide)
- [Install Dependencies](#install-dependencies)
- [Start Development](#start-development)
Expand Down Expand Up @@ -118,6 +117,45 @@ Compared to other AI tools, DeepChat offers the following unique advantages:
- **Privacy-Focused**: Local data storage and network proxy support reduce the risk of information leakage
- **Business-Friendly**: Embraces open source under the Apache License 2.0, suitable for both commercial and personal use

## 📦 Quick Start

### Download and Install

You can install DeepChat using one of the following methods:

**Option 1: GitHub Releases**

Download the latest version for your system from the [GitHub Releases](https://github.com/ThinkInAIXYZ/deepchat/releases) page:

- Windows: `.exe` installation file
- macOS: `.dmg` installation file
- Linux: `.AppImage` or `.deb` installation file

**Option 2: Official Website**

Download from the [official website](https://deepchatai.cn/#/download).

**Option 3: Homebrew (macOS only)**

For macOS users, you can install DeepChat using Homebrew:

```bash
brew install --cask deepchat
```

### Configure Models

1. Launch the DeepChat application
2. Click the settings icon
3. Select the "Model Providers" tab
4. Add your API keys or configure local Ollama

### Start Conversations

1. Click the "+" button to create a new conversation
2. Select the model you want to use
3. Start communicating with your AI assistant

## 🔥 Main Features

- 🤖 **Local-First Agent Desktop Client**
Expand Down Expand Up @@ -148,7 +186,7 @@ Compared to other AI tools, DeepChat offers the following unique advantages:
- Supports rendering images, Mermaid diagrams, and other multi-modal content; supports GPT-4o, Gemini, Grok text-to-image capabilities
- Supports highlighting external information sources like search results within the content
- 🔍 **Robust Search Extension Capabilities**
- Built-in integration with leading search APIs like BoSearch and Brave Search, allowing the model to intelligently decide when to search
- Built-in integration with leading search APIs like Bocha Search and Brave Search, allowing the model to intelligently decide when to search
- Supports mainstream search engines like Google, Bing, Baidu, and Sogou Official Accounts search by simulating user web browsing, enabling the LLM to read search engines like a human
- Supports reading any search engine; simply configure a search assistant model to connect various search sources, whether internal networks, API-less engines, or vertical domain search engines, as information sources for the model
- 🔧 **Strong MCP (Model Context Protocol) Support**
Expand All @@ -169,8 +207,6 @@ Compared to other AI tools, DeepChat offers the following unique advantages:
- Clear code structure, both model providers and MCP services are highly decoupled, can be freely customized with minimal cost
- Reasonable architecture, data interaction and UI behavior separation, fully utilizing Electron's capabilities, rejecting simple web wrappers, excellent performance

For more details on how to use these features, see the [documentation index](./docs/README.md).

## 📼 Tape & Trace

DeepChat's session Tape follows the Tape.systems philosophy and keeps agent work recoverable and inspectable. Trace previews expose request sequences, provider/model metadata, Tape view manifests, included or excluded entries, and token budgets, making long-running agent sessions easier to debug and resume.
Expand All @@ -181,7 +217,7 @@ DeepChat Skills are designed to be compatible with the standard Agent Skills spe

You can install Skills from folders, ZIP files, or URLs, and import/export them with Claude Code, Codex, Cursor, Windsurf, GitHub Copilot, Kiro, Antigravity, OpenCode, Goose, Kilo Code, and other compatible tools.

Built-in Skills cover generative art, code review, DeepChat settings, document collaboration, DOCX, frontend design, git commit messages, infographic syntax, MCP building, PDF, PPTX, Skill creation, Web Artifacts, and XLSX workflows.
Built-in Skills cover algorithmic art, code review, DeepChat CLI, DeepChat settings, document collaboration, DOCX, frontend design, git commit messages, infographic syntax, MCP building, memory management, PDF, PPTX, Skill creation, and XLSX workflows.

Quick start:

Expand Down Expand Up @@ -425,6 +461,8 @@ Common commands include `/start`, `/help`, `/pair`, `/new`, `/sessions`, `/use`,

### Compatible with any model provider in OpenAI/Gemini/Anthropic API format

Any service that speaks the OpenAI, Gemini, or Anthropic API format can be added as a custom provider next to the built-in ones.

## 🔍 Use Cases

DeepChat is suitable for various AI application scenarios:
Expand All @@ -435,47 +473,6 @@ DeepChat is suitable for various AI application scenarios:
- **Content Creation**: Copywriting, creative inspiration, content optimization
- **Data Analysis**: Data interpretation, chart generation, report writing

## 📦 Quick Start

### Download and Install

You can install DeepChat using one of the following methods:

**Option 1: GitHub Releases**

Download the latest version for your system from the [GitHub Releases](https://github.com/ThinkInAIXYZ/deepchat/releases) page:

- Windows: `.exe` installation file
- macOS: `.dmg` installation file
- Linux: `.AppImage` or `.deb` installation file

**Option 2: Official Website**

Download from the [official website](https://deepchatai.cn/#/download).

**Option 3: Homebrew (macOS only)**

For macOS users, you can install DeepChat using Homebrew:

```bash
brew install --cask deepchat
```

### Configure Models

1. Launch the DeepChat application
2. Click the settings icon
3. Select the "Model Providers" tab
4. Add your API keys or configure local Ollama

### Start Conversations

1. Click the "+" button to create a new conversation
2. Select the model you want to use
3. Start communicating with your AI assistant

For a comprehensive guide on getting started and using all features, please refer to the [documentation index](./docs/README.md).

## 💻 Development Guide

Please read the [Contribution Guidelines](./CONTRIBUTING.md)
Expand Down Expand Up @@ -521,7 +518,7 @@ $ pnpm run build:linux:x64
$ pnpm run build:linux:arm64
```

For a more detailed guide on development, project structure, and architecture, please see the [Developer Guide](./docs/guides/getting-started.md).
For a more detailed guide on development, project structure, and architecture, please see the [Developer Guide](./docs/guides/getting-started.md) and the maintained [documentation index](./docs/README.md).

## 👥 Community & Contribution

Expand All @@ -531,7 +528,7 @@ DeepChat is an active open-source community project, and we welcome various form
- 💡 [Submit feature suggestions](https://github.com/ThinkInAIXYZ/deepchat/issues)
- 🔧 [Submit code improvements](https://github.com/ThinkInAIXYZ/deepchat/pulls)
- 📚 [Improve documentation](https://github.com/ThinkInAIXYZ/deepchat/wiki)
- 🌍 [Help with translation](https://github.com/ThinkInAIXYZ/deepchat/tree/main/locales)
- 🌍 [Help with translation](https://github.com/ThinkInAIXYZ/deepchat/tree/main/src/renderer/src/i18n)

Check the [Contribution Guidelines](./CONTRIBUTING.md) to learn more about ways to participate in the project.

Expand Down
Loading