aibo/BoosAPI
1
0
Fork 0
forked from boos/BoosAPI
Code Pull Requests Activity

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

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files
desktop/website/docs/hi/guide/gateway.md
+74
View File
@@ -0,0 +1,74 @@
# API गेटवे
## API गेटवे क्या है?
BoosApi में एक बिल्ट-इन लोकल API सर्वर है जो आपके कॉन्फ़िगर किए गए प्रदाताओं को **OpenAI-कम्पैटिबल**, **Claude-नेटिव** और **Gemini-नेटिव** एंडपॉइंट के रूप में एक्सपोज़ करता है। इन प्रोटोकॉल में से किसी का भी उपयोग करने वाला कोई भी टूल या क्लाइंट BoosApi को बैकएंड के रूप में उपयोग कर सकता है।
उपयोग केस:
- BoosApi के माध्यम से **Claude Code CLI**, **OpenAI Codex CLI**, **Gemini CLI**, या **OpenCode** चलाएं।
- अपने IDE एक्सटेंशन को एकल, लोकल रूप से प्रबंधित एंडपॉइंट से फीड करें।
- प्रति-की रेट लिमिटिंग के साथ कई टूल्स में प्रदाता कीज़ का एक सेट साझा करें।
---
## शुरुआत
1. **Settings → API Gateway** खोलें (या <kbd>Cmd/Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>G</kbd> दबाएं)।
2. गेटवे सर्वर लॉन्च करने के लिए **Start** क्लिक करें।
3. डिफ़ॉल्ट रूप से सर्वर `127.0.0.1:8080` (HTTP) पर सुनता है।
::: tip
BoosApi शुरू होने पर सर्वर ऑटोमैटिकली लॉन्च हो, इसके लिए गेटवे Settings में **Auto-start** एनेबल करें।
:::
---
## API की मैनेजमेंट
1. **API Keys** टैब में जाएं।
2. **Generate New Key** क्लिक करें।
3. वैकल्पिक रूप से हर की की पहचान के लिए **description** जोड़ें।
4. की कॉपी करें — यह केवल एक बार दिखाई देती है।
---
## कॉन्फ़िगरेशन टेम्पलेट
### Claude Code CLI
```bash
claude config set --global apiUrl http://127.0.0.1:8080
claude config set --global apiKey boosapi-xxxx
```
### OpenAI Codex CLI
```bash
export OPENAI_BASE_URL=http://127.0.0.1:8080/v1
export OPENAI_API_KEY=boosapi-xxxx
codex
```
### Gemini CLI
```bash
export GEMINI_API_BASE=http://127.0.0.1:8080
export GEMINI_API_KEY=boosapi-xxxx
gemini
```
### कस्टम क्लाइंट
```
Base URL: http://127.0.0.1:8080/v1
API Key: boosapi-xxxx
```
---
## अगले कदम
- [त्वरित प्रारंभ](./getting-started) — क्विक स्टार्ट गाइड पर वापस जाएं
- [प्रदाता कॉन्फ़िगर करें](./providers) — गेटवे जिन अपस्ट्रीम प्रदाताओं को रूट करता है, उन्हें जोड़ें
- [MCP सर्वर](./mcp) — AI टूल कॉलिंग के लिए बाहरी टूल्स कनेक्ट करें
desktop/website/docs/hi/guide/getting-started.md
+117
View File
@@ -0,0 +1,117 @@
# त्वरित प्रारंभ
## इंस्टॉलेशन
[डाउनलोड पेज](/hi/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** को **Applications** फोल्डर में ड्रैग करें।
2. BoosApi लॉन्च करें। अगर macOS ऐप को ब्लॉक करे, **System Settings → Privacy & Security** में जाएं और **Open Anyway** क्लिक करें।
::: warning macOS: "App Is Damaged" या "Cannot Verify Developer"
अगर ये संदेश दिखाई दें, तो Terminal खोलें और चलाएं:
```bash
xattr -c /Applications/BoosApi.app
```
फिर ऐप दोबारा लॉन्च करें।
:::
### Windows
| आर्किटेक्चर | फ़ाइल |
|------------|-------|
| x64 (अधिकांश PC) | `BoosApi_x.x.x_x64-setup.exe` |
| ARM64 | `BoosApi_x.x.x_arm64-setup.exe` |
इंस्टॉलर चलाएं और विज़ार्ड का पालन करें।
### Linux
```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. Settings खोलें
BoosApi लॉन्च करें और साइडबार के नीचे **gear आइकन** क्लिक करें, या <kbd>Cmd/Ctrl</kbd>+<kbd>,</kbd> दबाएं।
### 2. प्रदाता जोड़ें
**Settings → Providers** में जाएं और **+** बटन क्लिक करें।
1. एक डिस्प्ले नेम दर्ज करें (जैसे *OpenAI*)।
2. प्रदाता प्रकार चुनें (OpenAI, Anthropic, Google Gemini, आदि)।
3. अपनी API कुंजी पेस्ट करें।
4. **Base URL** कन्फर्म करें — बिल्ट-इन प्रकारों के लिए आधिकारिक एंडपॉइंट पहले से भरा है।
::: tip
आप जितने चाहें उतने प्रदाता जोड़ सकते हैं।
:::
### 3. मॉडल फ़ेच करें
**Fetch Models** क्लिक करें प्रदाता की API से उपलब्ध मॉडलों की सूची प्राप्त करने के लिए।
### 4. डिफ़ॉल्ट मॉडल सेट करें
**Settings → Default Model** में जाएं और प्रदाता और मॉडल चुनें जो नई वार्तालाप डिफ़ॉल्ट रूप से उपयोग करें।
---
## आपकी पहली वार्तालाप
1. साइडबार में **New Chat** क्लिक करें (या <kbd>Cmd/Ctrl</kbd>+<kbd>N</kbd> दबाएं)।
2. चैट के शीर्ष पर मॉडल सेलेक्टर से एक मॉडल चुनें।
3. एक संदेश टाइप करें और <kbd>Enter</kbd> दबाएं।
4. BoosApi रियल-टाइम में रेस्पॉन्स स्ट्रीम करता है।
---
## शॉर्टकट
| शॉर्टकट | क्रिया |
|---------|--------|
| <kbd>Cmd/Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>A</kbd> | वर्तमान विंडो दिखाएं / छुपाएं |
| <kbd>Cmd/Ctrl</kbd>+<kbd>N</kbd> | नई वार्तालाप |
| <kbd>Cmd/Ctrl</kbd>+<kbd>,</kbd> | Settings खोलें |
| <kbd>Cmd/Ctrl</kbd>+<kbd>K</kbd> | Command palette |
| <kbd>Cmd/Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>G</kbd> | API गेटवे टॉगल करें |
---
## डेटा और बैकअप
### डेटा डायरेक्टरी
| पथ | सामग्री |
|----|---------|
| `~/.boosapi/` | एप्लिकेशन स्टेट — डेटाबेस, एन्क्रिप्शन कीज़, वेक्टर DB, SSL सर्टिफिकेट |
| `~/Documents/boosapi/` | यूज़र फ़ाइलें — इमेज, दस्तावेज़, बैकअप |
---
## अगले कदम
- [प्रदाता कॉन्फ़िगर करें](./providers) — AI प्रदाता जोड़ें और प्रबंधित करें
- [MCP सर्वर](./mcp) — AI क्षमताओं को बढ़ाने के लिए बाहरी टूल्स कनेक्ट करें
- [API गेटवे](./gateway) — अपने प्रदाताओं को लोकल API सर्वर के रूप में एक्सपोज़ करें
desktop/website/docs/hi/guide/mcp.md
+62
View File
@@ -0,0 +1,62 @@
# MCP सर्वर
## MCP क्या है?
[Model Context Protocol (MCP)](https://modelcontextprotocol.io/) एक ओपन स्टैंडर्ड है जो AI मॉडलों को बाहरी टूल्स और डेटा स्रोतों के साथ इंटरैक्ट करने देता है। BoosApi MCP क्लाइंट के रूप में काम करता है — आप MCP सर्वर जोड़ते हैं, और AI वार्तालाप के दौरान उनके एक्सपोज़ टूल कॉल कर सकता है।
---
## ट्रांसपोर्ट प्रोटोकॉल
| प्रोटोकॉल | कनेक्शन | उपयोग केस | कॉन्फ़िगरेशन |
|---------|---------|---------|------------|
| **Stdio** | लोकल प्रोसेस | `npx`, `uvx`, `python` आदि से लॉन्च टूल्स | `command` + `args` + वैकल्पिक `env` |
| **SSE** | रिमोट सर्वर | रिमोट मशीन पर होस्ट Server-Sent Events एंडपॉइंट | `url` |
| **StreamableHTTP** | रिमोट सर्वर | HTTP स्ट्रीमिंग एंडपॉइंट | `url` |
---
## MCP सर्वर जोड़ना
### फॉर्म से बनाना
1. **Settings → MCP Servers** में जाएं।
2. **Add MCP Server** क्लिक करें।
3. एक नाम दर्ज करें और ट्रांसपोर्ट प्रोटोकॉल चुनें।
4. अपने चुने हुए प्रोटोकॉल के लिए फ़ील्ड भरें।
5. **Save** क्लिक करें।
### JSON इम्पोर्ट
**JSON Import** क्लिक करें और कॉन्फ़िगरेशन ऑब्जेक्ट पेस्ट करें:
```json
{
"mcpServers": {
"fetch": {
"command": "uvx",
"args": ["mcp-server-fetch"]
}
}
}
```
---
## बिल्ट-इन टूल्स
| टूल | विवरण |
|-----|-------|
| **@boosapi/fetch** | वेब पेज और HTTP रिसोर्स फ़ेच करें |
| **@boosapi/search-file** | लोकल फ़ाइल सिस्टम में फ़ाइलें खोजें |
---
## Tool loop limit
Settings -> MCP में MCP-enabled response के लिए consecutive tool-call iterations की maximum संख्या सेट कर सकते हैं। Unknown servers टेस्ट करते समय limit कम रखें, और multi-tool workflows के लिए इसे बढ़ा सकते हैं।
## अगले कदम
- [API गेटवे](./gateway) — अपने प्रदाताओं को लोकल API सर्वर के रूप में एक्सपोज़ करें
- [त्वरित प्रारंभ](./getting-started) — क्विक स्टार्ट गाइड पर वापस जाएं
desktop/website/docs/hi/guide/providers.md
+143
View File
@@ -0,0 +1,143 @@
# प्रदाता कॉन्फ़िगर करें
BoosApi एक साथ किसी भी संख्या में AI प्रदाताओं से कनेक्ट होता है। प्रत्येक प्रदाता की अपनी API कीज़, मॉडल लिस्ट और पैरामीटर डिफ़ॉल्ट होते हैं।
## समर्थित प्रदाता
| प्रदाता | उदाहरण मॉडल |
|---------|------------|
| **OpenAI** | GPT-4o, GPT-4, o3, o4-mini |
| **Anthropic** | Claude 4 Sonnet, Claude 4 Opus, Claude 3.5 Sonnet |
| **Google** | Gemini 2.5 Pro, Gemini 2.5 Flash, Gemini 2.0 |
| **DeepSeek** | DeepSeek V3, DeepSeek R1 |
| **Alibaba Cloud** | Qwen सीरीज़ |
| **Zhipu AI** | GLM सीरीज़ |
| **xAI** | Grok सीरीज़ |
| **OpenAI-कम्पैटिबल API** | Ollama, vLLM, LiteLLM, थर्ड-पार्टी रिले, आदि |
---
## प्रदाता जोड़ना
1. **Settings → Providers** में जाएं।
2. नीचे बाईं ओर **+** बटन क्लिक करें।
3. प्रदाता विवरण भरें:
| फ़ील्ड | विवरण |
|--------|-------|
| **नाम** | साइडबार के लिए डिस्प्ले नेम (जैसे *OpenAI*) |
| **प्रकार** | प्रदाता प्रकार — डिफ़ॉल्ट Base URL निर्धारित करता है |
| **आइकन** | विज़ुअल पहचान के लिए वैकल्पिक आइकन |
| **API कुंजी** | आपके प्रदाता के डैशबोर्ड से गुप्त कुंजी |
| **Base URL** | API एंडपॉइंट (बिल्ट-इन प्रकारों के लिए पूर्व-भरा) |
| **API पथ** | रिक्वेस्ट पथ — डिफ़ॉल्ट `/v1/chat/completions` |
---
## वेबसाइट लिंक से आयात करना
प्रदाता वेबसाइट, रिले सेवा डैशबोर्ड, निजी मॉडल प्लेटफ़ॉर्म या लोकल गेटवे पेज **BoosApi में खोलें** लिंक दे सकते हैं। क्लिक करने पर ब्राउज़र BoosApi डेस्कटॉप ऐप खोलता है, BoosApi **Settings → Providers** पर जाता है, पुष्टि डायलॉग दिखाता है और उपयोगकर्ता की पुष्टि के बाद ही कॉन्फ़िगरेशन आयात करता है।
### उपयोगकर्ता प्रवाह
1. प्रदाता लिंक आयात सपोर्ट करने वाला BoosApi संस्करण इंस्टॉल करके खोलें।
2. ब्राउज़र में प्रदाता का **BoosApi में खोलें** लिंक क्लिक करें।
3. BoosApi में प्रदाता नाम, Base URL, प्रदाता प्रकार और API key prefix जांचें।
4. BoosApi समान **Base URL + प्रकार** वाले मौजूदा प्रदाता को पुनः उपयोग करता है। यदि वह मौजूद नहीं है, तो नया प्रदाता बनाता है और API key केवल तब जोड़ता है जब वह पहले से मौजूद न हो।
BoosApi API key को अपने-आप validate नहीं करता और मॉडल सूची अपने-आप fetch नहीं करता। आयात के बाद **Fetch Models** क्लिक करें या मॉडल ID मैन्युअल रूप से जोड़ें।
### लिंक फ़ॉर्मेट
```text
boosapi://providers?name=<name>&baseurl=<base-url>&apikey=<api-key>&type=<provider-type>
```
उदाहरण:
```text
boosapi://providers?name=OpenAI&baseurl=https%3A%2F%2Fapi.openai.com&apikey=sk-xxx&type=openai
```
### पैरामीटर
| पैरामीटर | आवश्यक | विवरण |
|----------|--------|-------|
| `name` | हाँ | BoosApi में दिखने वाला नाम, जैसे `OpenAI` या `My Relay` |
| `baseurl` | हाँ | URL-encoded Base URL। केवल `http` और `https` स्वीकार हैं; query और hash अस्वीकार किए जाते हैं। |
| `apikey` | हाँ | BoosApi में सेव की जाने वाली API key। पुष्टि डायलॉग में BoosApi केवल prefix दिखाता है। |
| `type` | हाँ | प्रदाता प्रकार। मान्य values: `openai`, `openai_responses`, `anthropic`, `gemini`, `custom`. |
`baseurl` BoosApi के मौजूदा force suffix का उपयोग कर सकता है, जैसे `https://example.com!`। लिंक से आयात करते समय `api_path` सेट नहीं होता; BoosApi चुने गए प्रदाता प्रकार का डिफ़ॉल्ट path इस्तेमाल करता है।
### वेबसाइट कॉन्फ़िगरेशन
हर dynamic value को `encodeURIComponent` या `URLSearchParams` से encode करें:
```html
<a id="open-boosapi" href="#">BoosApi में खोलें</a>
<script>
const provider = {
name: 'My Relay',
baseurl: 'https://api.example.com',
apikey: 'sk-user-key',
type: 'openai',
};
const params = new URLSearchParams({
name: provider.name,
baseurl: provider.baseurl,
apikey: provider.apikey,
type: provider.type,
});
document.getElementById('open-boosapi').href = `boosapi://providers?${params.toString()}`;
</script>
```
यदि आपका सेवा API key ऑनलाइन generate करती है, तो लिंक केवल उपयोगकर्ता के sign in करने और स्पष्ट रूप से key चुनने या बनाने के बाद generate करें।
::: warning सुरक्षा
URL में API key ब्राउज़र history, logs, extensions या analytics tools में दिखाई दे सकती है। असली keys को public pages, static HTML या third-party redirects में न डालें। बेहतर है कि लिंक private account page पर user confirmation के बाद generate किया जाए।
:::
::: tip टेस्टिंग
`boosapi://` एक custom protocol है जिसे installed desktop app सिस्टम में register करती है। केवल वेबसाइट या Vite dev server चलाने से protocol register नहीं होता। यदि link BoosApi नहीं खोलता, तो पहले latest BoosApi desktop app install या rebuild करें।
:::
---
## CC Switch से import
BoosApi Settings -> Providers में CC Switch provider configurations स्कैन कर सकता है। हर candidate देखें, importable rows चुनें, फिर providers, Base URLs, API keys और model lists BoosApi में import करें। OAuth-only entries या reusable keys के बिना entries visible reason के साथ skip होती हैं।
## Advanced model request body
हर model extra_body define कर सकता है, जो OpenAI-compatible Chat Completions requests में flat JSON object के रूप में जोड़ा जाता है। यह enable_thinking जैसे vendor-specific options के लिए उपयोगी है। BoosApi JSON validate करता है और model, messages, stream, tools तथा base sampling fields overwrite होने से रोकता है।
## मल्टी-की रोटेशन
BoosApi लोड वितरण के लिए प्रति प्रदाता कई API कीज़ सपोर्ट करता है। प्रदाता डिटेल पैनल में **Add Key** क्लिक करें।
---
## मॉडल प्रबंधन
उपलब्ध मॉडलों की पूरी सूची प्राप्त करने के लिए **Fetch Models** क्लिक करें। आप मॉडल ID मैन्युअल रूप से भी जोड़ सकते हैं।
---
## Ollama (लोकल मॉडल)
1. [Ollama](https://ollama.com/) इंस्टॉल और स्टार्ट करें।
2. BoosApi में **OpenAI** प्रकार के साथ नया प्रदाता बनाएं।
3. **Base URL** को `http://localhost:11434` पर सेट करें।
4. लोकल रूप से डाउनलोड किए गए मॉडल खोजने के लिए **Fetch Models** क्लिक करें।
---
## अगले कदम
- [MCP सर्वर](./mcp) — AI क्षमताओं को बढ़ाने के लिए बाहरी टूल्स कनेक्ट करें
- [API गेटवे](./gateway) — अपने प्रदाताओं को लोकल API सर्वर के रूप में एक्सपोज़ करें