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
@@ -0,0 +1,128 @@
|
||||
# Быстрый старт
|
||||
|
||||
## Установка
|
||||
|
||||
Скачайте последний установщик со [страницы загрузки](/ru/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 (большинство ПК) | `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** — официальный endpoint предзаполнен для встроенных типов.
|
||||
|
||||
::: tip
|
||||
Вы можете добавить столько провайдеров, сколько захотите. Каждый провайдер управляет своими ключами API и моделями независимо.
|
||||
:::
|
||||
|
||||
### 3. Получить модели
|
||||
|
||||
Нажмите **Получить модели**, чтобы загрузить список доступных моделей из API провайдера. Вы также можете добавлять ID моделей вручную при необходимости.
|
||||
|
||||
### 4. Установить модель по умолчанию
|
||||
|
||||
Перейдите в **Настройки → Модель по умолчанию** и выберите провайдера и модель, которые новые разговоры должны использовать по умолчанию.
|
||||
|
||||
---
|
||||
|
||||
## Ваш первый разговор
|
||||
|
||||
1. Нажмите **Новый чат** в боковой панели (или нажмите <kbd>Cmd/Ctrl</kbd>+<kbd>N</kbd>).
|
||||
2. Выберите модель из селектора моделей вверху чата.
|
||||
3. Введите сообщение и нажмите <kbd>Enter</kbd>.
|
||||
4. BoosApi транслирует ответ в реальном времени. Модели с поддержкой блоков размышлений (например, Claude, DeepSeek R1) отображают процесс рассуждений в сворачиваемом разделе.
|
||||
|
||||
---
|
||||
|
||||
## Горячие клавиши
|
||||
|
||||
| Сочетание | Действие |
|
||||
|-----------|---------|
|
||||
| <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>G</kbd> | Переключить API-шлюз |
|
||||
|
||||
---
|
||||
|
||||
## Данные и резервное копирование
|
||||
|
||||
### Каталоги данных
|
||||
|
||||
| Путь | Содержимое |
|
||||
|------|-----------|
|
||||
| `~/.boosapi/` | Состояние приложения — база данных, ключи шифрования, векторная БД, SSL-сертификаты |
|
||||
| `~/Documents/boosapi/` | Файлы пользователя — изображения, документы, резервные копии |
|
||||
|
||||
---
|
||||
|
||||
## Следующие шаги
|
||||
|
||||
- [Настройка провайдеров](./providers) — добавление и управление ИИ-провайдерами
|
||||
- [MCP-серверы](./mcp) — подключение внешних инструментов для расширения возможностей ИИ
|
||||
- [API-шлюз](./gateway) — предоставление провайдеров как локального API-сервера
|
||||
Reference in New Issue
Block a user