feat(desktop): embed BoosAPI Desktop client as a subproject

Vendor the rebranded BoosAPI Desktop client (Tauri + Vue) into metapi as
a monorepo subdirectory under desktop/. Source only — node_modules,
dist, Cargo target and the upstream .git history are excluded.

desktop/ keeps its own independent Cargo workspace (desktop/src-tauri
with crates/*); it is not part of the backend boosapi crate, so a
`cargo check` at the metapi root still compiles only the backend. Build
the desktop app from desktop/src-tauri per desktop/README.md.

Note: app icons are still placeholder assets pending the final BoosAPI
logo. The updater signing keys live outside the repo and are not
included.
This commit is contained in:
boos
2026-06-22 11:32:57 +08:00
parent d9c78ecc73
commit e0a5f57793
2305 changed files with 449355 additions and 0 deletions
@@ -0,0 +1,197 @@
# クイックスタート
## インストール
[ダウンロードページ](/ja/download) または [GitHub Releases](https://github.com/BoosApi-Desktop/BoosApi/releases) から最新のインストーラーをダウンロードしてください。
### macOS
| チップ | ファイル |
|--------|---------|
| Apple Silicon (M1 / M2 / M3 / M4) | `BoosApi_x.x.x_aarch64.dmg` |
| Intel | `BoosApi_x.x.x_x64.dmg` |
1. `.dmg` を開き、**BoosApi** を**アプリケーション**フォルダにドラッグします。
2. BoosApi を起動します。macOS がアプリをブロックした場合は、**システム設定 → プライバシーとセキュリティ**に移動して**このまま開く**をクリックしてください。
::: warning macOS: 「アプリが壊れている」または「開発元を確認できない」
これらのメッセージのいずれかが表示された場合は、ターミナルを開いて以下を実行してください:
```bash
xattr -c /Applications/BoosApi.app
```
その後、アプリを再度起動します。これにより、macOS が未署名のダウンロードに適用する検疫フラグが削除されます。
:::
### Windows
| アーキテクチャ | ファイル |
|--------------|---------|
| x64(ほとんどの PC) | `BoosApi_x.x.x_x64-setup.exe` |
| ARM64 | `BoosApi_x.x.x_arm64-setup.exe` |
インストーラーを実行してウィザードに従います。スタートメニューまたはデスクトップショートカットから BoosApi を起動します。
### Linux
| 形式 | アーキテクチャ | ファイル |
|------|--------------|---------|
| Debian / Ubuntu | x64 | `BoosApi_x.x.x_amd64.deb` |
| Debian / Ubuntu | ARM64 | `BoosApi_x.x.x_arm64.deb` |
| Fedora / openSUSE | x64 | `BoosApi_x.x.x_x86_64.rpm` |
| Fedora / openSUSE | ARM64 | `BoosApi_x.x.x_aarch64.rpm` |
| 任意のディストリビューション | x64 | `BoosApi_x.x.x_amd64.AppImage` |
| 任意のディストリビューション | ARM64 | `BoosApi_x.x.x_aarch64.AppImage` |
```bash
# Debian / Ubuntu
sudo dpkg -i BoosApi_x.x.x_amd64.deb
# Fedora / openSUSE
sudo rpm -i BoosApi_x.x.x_x86_64.rpm
# AppImage(任意のディストリビューション)
chmod +x BoosApi_x.x.x_amd64.AppImage
./BoosApi_x.x.x_amd64.AppImage
```
---
## 初期設定
### 1. 設定を開く
BoosApi を起動し、サイドバー下部の**歯車アイコン**をクリックするか、<kbd>Cmd/Ctrl</kbd>+<kbd>,</kbd> を押します。
### 2. プロバイダーを追加する
**設定 → プロバイダー**に移動し、**+** ボタンをクリックします。
1. 表示名を入力します(例:*OpenAI*)。
2. プロバイダータイプを選択します(OpenAI、Anthropic、Google Gemini など)。
3. API キーを貼り付けます。
4. **Base URL** を確認します — ビルトインタイプには公式エンドポイントが事前入力されています。サードパーティのリレーやプロキシを使用する場合のみ変更してください。
::: tip
プロバイダーはいくつでも追加できます。各プロバイダーは独自の API キーとモデルのセットを個別に管理します。
:::
### 3. モデルを取得する
**モデルを取得**をクリックして、プロバイダーの API から利用可能なモデルのリストを取得します。必要に応じてモデル ID を手動で追加することもできます。
### 4. デフォルトモデルを設定する
**設定 → デフォルトモデル**に移動し、新しい会話でデフォルトとして使用するプロバイダーとモデルを選択します。
---
## 最初の会話
1. サイドバーの**新規チャット**をクリックします(または <kbd>Cmd/Ctrl</kbd>+<kbd>N</kbd> を押します)。
2. チャット上部のモデルセレクターからモデルを選択します。
3. メッセージを入力して <kbd>Enter</kbd> を押します。
4. BoosApi はリアルタイムでレスポンスをストリーミングします。思考ブロックをサポートするモデル(Claude、DeepSeek R1 など)は、回答の上の折りたたみ可能なセクションに推論プロセスを表示します。
---
## 主要概念
### 会話ブランチ
任意のメッセージを編集または再生成してブランチを作成します。元のバージョンと新しいバージョンは同じ会話ツリーに共存します — 各メッセージの矢印コントロールでナビゲートできます。
### メッセージバージョン
再生成のたびに新しいバージョンが作成されます。メッセージバブルの **◀ ▶** 矢印でバージョンを切り替えられます。
### コンテキスト添付
ファイル、検索結果、MCP ツール出力を会話コンテキストに直接添付してプロンプトを充実させます。
---
## ショートカット
以下はデフォルトのキーボードショートカットです。すべてのショートカットは**設定 → ショートカット**でカスタマイズできます。
| ショートカット | アクション |
|--------------|-----------|
| <kbd>Cmd/Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>A</kbd> | 現在のウィンドウを表示/非表示 |
| <kbd>Cmd/Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>Alt</kbd>+<kbd>A</kbd> | すべてのウィンドウを表示/非表示 |
| <kbd>Cmd/Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>W</kbd> | ウィンドウを閉じる |
| <kbd>Cmd/Ctrl</kbd>+<kbd>N</kbd> | 新規会話 |
| <kbd>Cmd/Ctrl</kbd>+<kbd>,</kbd> | 設定を開く |
| <kbd>Cmd/Ctrl</kbd>+<kbd>K</kbd> | コマンドパレット |
| <kbd>Cmd/Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>M</kbd> | モデルセレクターを切り替え |
| <kbd>Cmd/Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>↑</kbd> | 最後のメッセージを入力 |
| <kbd>Cmd/Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>K</kbd> | コンテキストをクリア |
| <kbd>Cmd/Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>Backspace</kbd> | 会話メッセージをクリア |
| <kbd>Cmd/Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>G</kbd> | API ゲートウェイを切り替え |
::: info
グローバルショートカット(ウィンドウの表示/非表示)は、BoosApi がバックグラウンドにある場合でもシステム全体で動作します。BoosApi は他のアプリケーションのショートカットとの競合を検出し、設定で警告を表示します。
:::
---
## デスクトップ設定
**設定**を開いてデスクトップ体験を設定します。
| 設定 | オプション |
|------|---------|
| **テーマ** | ダーク、ライト、またはシステム(自動) |
| **言語** | 日本語、English、简体中文 |
| **システムトレイ** | トレイに最小化、トレイに閉じる |
| **自動起動** | コンピューター起動時に BoosApi を起動 |
| **常に最前面** | ウィンドウを他のアプリの上に保持 |
| **プロキシ** | ホストとポートを指定した HTTP または SOCKS5 プロキシ |
---
## データとバックアップ
### データディレクトリ
BoosApi は 2 つの場所にデータを保存します:
| パス | 内容 |
|------|------|
| `~/.boosapi/` | アプリケーション状態 — データベース、暗号化キー、ベクトル DB、SSL 証明書 |
| `~/Documents/boosapi/` | ユーザーが見えるファイル — 画像、ドキュメント、バックアップ |
::: tip
Windows では、パスは `%USERPROFILE%\.boosapi\` と `%USERPROFILE%\Documents\boosapi\` になります。
:::
### 自動バックアップ
**設定 → バックアップ**に移動して自動バックアップを設定します:
- **有効** — 自動バックアップのオン/オフを切り替え。
- **間隔** — バックアップの頻度(時間単位)。
- **最大数** — 最古のバックアップが削除される前に保持するバックアップ数。
- **ストレージターゲット** — ローカルディレクトリ(デフォルト:`~/Documents/boosapi/backups/`)または WebDAV サーバー。
### 手動バックアップと復元
バックアップ設定パネルからいつでも手動バックアップを作成できます。復元するには、履歴リストからバックアップを選択して**復元**をクリックします。
### 会話エクスポート
サイドバーの会話を右クリックしてエクスポートします:
- **PNG** — チャットのレンダリングスクリーンショット
- **Markdown** — ヘッダー、コードブロック、LaTeX 付きフォーマット
- **プレーンテキスト** — メッセージ区切りのシンプルなテキスト
- **JSON** — 完全なメタデータを含む構造化データ
---
## 次のステップ
- [プロバイダーの設定](./providers) — AI プロバイダーの追加と管理
- [MCP サーバー](./mcp) — AI 機能を拡張する外部ツールの接続
- [API ゲートウェイ](./gateway) — プロバイダーをローカル API サーバーとして公開