| Name | sol9001-robodog JSON |
| Version |
2.5.0
JSON |
| download |
| home_page | None |
| Summary | A short description of Robodog |
| upload_time | 2025-08-24 02:58:42 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | None |
| keywords |
robot
dog
automation
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Robodog AI
## Overview
Robodog is a lightweight, zero-install, command-line style generative AI client that integrates multiple providers (OpenAI, OpenRouter, LlamaAI, DeepSeek, Anthropic, Sarvam AI, Google Search API, and more) into a unified interface. Key capabilities include:
- Access to cutting-edge models: `o4-mini` (200k context), `gpt-4`, `gpt-4-turbo`, `dall-e-3`, Llama3-70b, Claude Opus/Sonnet, Mistral, Sarvam-M, Gemma 3n, etc.
- Massive context windows (up to 200k tokens) across different models.
- Seamless chat history & knowledge management with stashes and snapshots.
- File import/export (text, Markdown, code, PDF, images via OCR).
- In-chat file inclusion from a local MCP server.
- Built-in web search integration.
- Image generation & OCR pipelines.
- Accessible, retro “console” UI with customizable themes and responsive design.
---
## Try Robodog
- **Web**: https://adourish.github.io/robodog/robodog/dist/
- **Android**: https://play.google.com/store/apps/details?id=com.unclebulgaria.robodog
- **npm packages**:
- `npm install robodoglib`
- `npm install robodogcli`
- `npm install robodog`
---
## Configuration
Click the ⚙️ icon in the top-menu to open settings:
Edit your YAML to configure providers, models, specialists, and the MCP server:
```yaml
configs:
providers:
- provider: openAI
baseUrl: "https://api.openai.com"
apiKey: "<YOUR_OPENAI_KEY>"
httpReferer: "https://adourish.github.io"
- provider: openRouter
baseUrl: "https://openrouter.ai/api/v1"
apiKey: "<YOUR_ROUTER_KEY>"
- provider: searchAPI
baseUrl: "https://google-search74.p.rapidapi.com"
apiKey: "<YOUR_RAPIDAPI_KEY>"
specialists:
- specialist: nlp
resume: natural language processing, content generation
- specialist: gi
resume: image generation from text
- specialist: search
resume: web search integration
mcpServer:
baseUrl: "http://localhost:2500"
apiKey: "testtoken"
models:
- provider: openAI
model: gpt-4
stream: true
specialist: nlp
about: best for reasoning
- provider: openAI
model: o4-mini
stream: true
specialist: nlp
about: 200k token context, advanced reasoning
- provider: openAI
model: dall-e-3
stream: false
specialist: gi
about: image creation
- provider: searchAPI
model: search
stream: false
specialist: search
about: web search results
```
---
## Supported Models
### OpenAI
- gpt-4, gpt-4-turbo, gpt-3.5-turbo, gpt-3.5-turbo-16k, o4-mini, o1
- dall-e-3
### Others
- LlamaAI: llama3-70b
- Anthropic: Claude Opus 4, Claude Sonnet 4
- DeepSeek R1
- Mistral Medium 3, Devstral-Small
- Sarvam-M
- Google Gemma 3n E4B
---
## Key Features
- **Multi-Provider Support**: Switch between any configured provider or model on the fly.
- **Chat & Knowledge**: Separate panes for Chat History (💭) and Knowledge (📝)—both resizable.
- **Stash Management**:
- `/stash <name>` — save current chat+knowledge
- `/pop <name>` — restore a stash
- `/list` — list all stashes
- CTRL+SHIFT+UP — cycle through stashes
- **File Import/Export**:
- `/import` — pick files (.md, .txt, .js, .py, .json, .yaml, .csv, PDFs, images)
- `/export <filename>` — download knowledge & chat snapshot
- 📤 / 📥 buttons in toolbar
- **MCP File Inclusion**:
- `/include all`
- `/include file=README.md`
- `/include pattern=*.js|*.css recursive`
- `/include dir=src pattern=*.py recursive`
Hand off included files into prompts seamlessly.
- **Web Search**: Enter `/search` mode or click 🔎 to perform live web queries.
- **Image Generation & OCR**: Ask questions to `dall-e-3` or drop an image to extract text via OCR.
- **Interactive Console UI**: Retro “pip-boy green” theme, responsive on desktop/mobile, accessible.
- **Performance & Size Indicators**: Emoji feedback for processing speed and token usage.
- **Extensive Command Palette**: `/help` lists all commands, indicators, and settings.
---
## Usage Examples
### Switch Model
```
/model o4-mini
```
→ “Model is set to o4-mini”
### Ask a Question
Simply type your query in the Chat💬 box and hit 🤖 or Enter.
### Import Files
Click 📤 or type:
```
/import
```
Select one or more files—content is appended to Knowledge📝.
### Export Snapshot
```
/export my_conversation.txt
```
Downloads a plain-text transcript of Chat History, Knowledge, and Content logs.
### Include Code from Your Project
```
/include pattern=*robodog*.js recursive
```
Includes all `*.js` files matching pattern under all configured project roots.
### Web Search
```
/search What is Robodog AI?
```
Returns top results with clickable links.
### Generate an Image
```
/dall-e-3 Create a sci-fi console UI in 1024x1024
```
→ Displays generated image inline.
---
## Robodog CLI
```bash
python robodog.py --folders c:\projects\robodog\robodogcli --port 2500 --token testtoken --config config.yaml --model o4-mini
```
```
## MCP File Service Syntax
```txt
/include all
/include file=*.md
/include pattern=*service*.js recursive
/include dir=src pattern=*.py recursive
```
*Globs: `*`, `?`, character classes. No full regex.*
---
## MCP Server Startup
```bash
python robodog.py --folders c:\projects\robodog\robodogcli --port 2500 --token testtoken --config config.yaml --model o4-mini
```
---
## Supported File Formats
- Text & Markdown: `.txt`, `.md`, `.markdown`
- Code: `.js`, `.ts`, `.py`, `.java`, `.c`, `.cpp`, `.go`, `.rs`
- Config/Data: `.yaml`, `.yml`, `.json`, `.xml`, `.csv`
- PDF: `.pdf`
- Images: `.png`, `.jpg`, `.jpeg`, `.gif`, `.bmp`, `.tiff`, `.pbm`, `.pgm`, `.ppm`
---
## Command Reference
Run `/help` in-app or see the list below:
```
/help — show help
/model <name> — switch model
/import — import files
/export <filename> — export snapshot
/clear — clear chat & knowledge
/stash <name> — stash chat+knowledge
/pop <name> — retrieve stash
/list — list stashes
/temperature <n> — set temperature (0–2)
/max_tokens <n> — set max tokens
/top_p <n> — set nucleus sampling
/frequency_penalty <n> — set frequency penalty
/presence_penalty <n> — set presence penalty
/rest — use REST completions
/stream — use streaming completions
/include … — include files via MCP
```
*Also supports keyboard shortcuts:*
- CTRL+SHIFT+UP to cycle stashes
- CTRL+S to save a snapshot
---
## Indicators & Emojis
- `[💭]` Chat History
- `[📝]` Knowledge Content
- `[💬]` Chat Text
- `[👾]` User
- `[🤖]` Assistant
- `[💾]` System
- `[🐋/🦕/🐘/🐁]` Token usage levels
- `[🐢/🦘/🐆/🦌/🐕]` Performance (response time)
---
## Accessibility & PWA
- Meets Section 508 and WCAG principles.
- Detects standalone ≥Installable as a PWA on supported devices.
---
## Build & Run
```bash
# Clone or unzip robodog
cd robodog
python build.py
# Open in browser
open ./dist/robodog.html
```
Experience the future of AI interaction—fast, contextual, and extensible. Enjoy Robodog AI!
Raw data
{
"_id": null,
"home_page": null,
"name": "sol9001-robodog",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "robot, dog, automation",
"author": null,
"author_email": "sol9001-robodog <sol9001@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/16/dd/1e64c3563a53c92a35254dd8047c4af5d8f23c185d00bcabcee34945ac3d/sol9001_robodog-2.5.0.tar.gz",
"platform": null,
"description": "# Robodog AI \r\n\r\n \r\n\r\n## Overview \r\nRobodog is a lightweight, zero-install, command-line style generative AI client that integrates multiple providers (OpenAI, OpenRouter, LlamaAI, DeepSeek, Anthropic, Sarvam AI, Google Search API, and more) into a unified interface. Key capabilities include:\r\n\r\n- Access to cutting-edge models: `o4-mini` (200k context), `gpt-4`, `gpt-4-turbo`, `dall-e-3`, Llama3-70b, Claude Opus/Sonnet, Mistral, Sarvam-M, Gemma 3n, etc. \r\n- Massive context windows (up to 200k tokens) across different models. \r\n- Seamless chat history & knowledge management with stashes and snapshots. \r\n- File import/export (text, Markdown, code, PDF, images via OCR). \r\n- In-chat file inclusion from a local MCP server. \r\n- Built-in web search integration. \r\n- Image generation & OCR pipelines. \r\n- Accessible, retro \u201cconsole\u201d UI with customizable themes and responsive design. \r\n\r\n---\r\n\r\n## Try Robodog \r\n\r\n- **Web**: https://adourish.github.io/robodog/robodog/dist/ \r\n- **Android**: https://play.google.com/store/apps/details?id=com.unclebulgaria.robodog \r\n- **npm packages**: \r\n - `npm install robodoglib` \r\n - `npm install robodogcli` \r\n - `npm install robodog` \r\n\r\n---\r\n\r\n## Configuration \r\n\r\nClick the \u2699\ufe0f icon in the top-menu to open settings: \r\n\r\n \r\n\r\nEdit your YAML to configure providers, models, specialists, and the MCP server: \r\n\r\n```yaml\r\nconfigs:\r\n providers:\r\n - provider: openAI\r\n baseUrl: \"https://api.openai.com\"\r\n apiKey: \"<YOUR_OPENAI_KEY>\"\r\n httpReferer: \"https://adourish.github.io\"\r\n - provider: openRouter\r\n baseUrl: \"https://openrouter.ai/api/v1\"\r\n apiKey: \"<YOUR_ROUTER_KEY>\"\r\n - provider: searchAPI\r\n baseUrl: \"https://google-search74.p.rapidapi.com\"\r\n apiKey: \"<YOUR_RAPIDAPI_KEY>\"\r\n\r\n specialists:\r\n - specialist: nlp\r\n resume: natural language processing, content generation\r\n - specialist: gi\r\n resume: image generation from text\r\n - specialist: search\r\n resume: web search integration\r\n\r\n mcpServer:\r\n baseUrl: \"http://localhost:2500\"\r\n apiKey: \"testtoken\"\r\n\r\n models:\r\n - provider: openAI\r\n model: gpt-4\r\n stream: true\r\n specialist: nlp\r\n about: best for reasoning\r\n - provider: openAI\r\n model: o4-mini\r\n stream: true\r\n specialist: nlp\r\n about: 200k token context, advanced reasoning\r\n - provider: openAI\r\n model: dall-e-3\r\n stream: false\r\n specialist: gi\r\n about: image creation\r\n - provider: searchAPI\r\n model: search\r\n stream: false\r\n specialist: search\r\n about: web search results\r\n```\r\n\r\n---\r\n\r\n## Supported Models \r\n\r\n### OpenAI \r\n- gpt-4, gpt-4-turbo, gpt-3.5-turbo, gpt-3.5-turbo-16k, o4-mini, o1 \r\n- dall-e-3 \r\n\r\n### Others \r\n- LlamaAI: llama3-70b \r\n- Anthropic: Claude Opus 4, Claude Sonnet 4 \r\n- DeepSeek R1 \r\n- Mistral Medium 3, Devstral-Small \r\n- Sarvam-M \r\n- Google Gemma 3n E4B \r\n\r\n---\r\n\r\n## Key Features \r\n\r\n- **Multi-Provider Support**: Switch between any configured provider or model on the fly. \r\n- **Chat & Knowledge**: Separate panes for Chat History (\ud83d\udcad) and Knowledge (\ud83d\udcdd)\u2014both resizable. \r\n- **Stash Management**: \r\n - `/stash <name>` \u2014 save current chat+knowledge \r\n - `/pop <name>` \u2014 restore a stash \r\n - `/list` \u2014 list all stashes \r\n - CTRL+SHIFT+UP \u2014 cycle through stashes \r\n- **File Import/Export**: \r\n - `/import` \u2014 pick files (.md, .txt, .js, .py, .json, .yaml, .csv, PDFs, images) \r\n - `/export <filename>` \u2014 download knowledge & chat snapshot \r\n - \ud83d\udce4 / \ud83d\udce5 buttons in toolbar \r\n  \r\n- **MCP File Inclusion**: \r\n - `/include all` \r\n - `/include file=README.md` \r\n - `/include pattern=*.js|*.css recursive` \r\n - `/include dir=src pattern=*.py recursive` \r\n Hand off included files into prompts seamlessly. \r\n- **Web Search**: Enter `/search` mode or click \ud83d\udd0e to perform live web queries. \r\n- **Image Generation & OCR**: Ask questions to `dall-e-3` or drop an image to extract text via OCR. \r\n- **Interactive Console UI**: Retro \u201cpip-boy green\u201d theme, responsive on desktop/mobile, accessible. \r\n- **Performance & Size Indicators**: Emoji feedback for processing speed and token usage. \r\n- **Extensive Command Palette**: `/help` lists all commands, indicators, and settings. \r\n\r\n \r\n---\r\n\r\n## Usage Examples \r\n\r\n### Switch Model \r\n```\r\n/model o4-mini\r\n```\r\n\u2192 \u201cModel is set to o4-mini\u201d \r\n\r\n### Ask a Question \r\nSimply type your query in the Chat\ud83d\udcac box and hit \ud83e\udd16 or Enter. \r\n\r\n### Import Files \r\nClick \ud83d\udce4 or type: \r\n```\r\n/import\r\n``` \r\nSelect one or more files\u2014content is appended to Knowledge\ud83d\udcdd. \r\n\r\n### Export Snapshot \r\n```\r\n/export my_conversation.txt\r\n``` \r\nDownloads a plain-text transcript of Chat History, Knowledge, and Content logs. \r\n\r\n### Include Code from Your Project \r\n```\r\n/include pattern=*robodog*.js recursive\r\n``` \r\nIncludes all `*.js` files matching pattern under all configured project roots. \r\n\r\n### Web Search \r\n```\r\n/search What is Robodog AI?\r\n``` \r\nReturns top results with clickable links. \r\n\r\n### Generate an Image \r\n```\r\n/dall-e-3 Create a sci-fi console UI in 1024x1024\r\n``` \r\n\u2192 Displays generated image inline. \r\n\r\n---\r\n\r\n## Robodog CLI\r\n \r\n\r\n```bash\r\npython robodog.py --folders c:\\projects\\robodog\\robodogcli --port 2500 --token testtoken --config config.yaml --model o4-mini\r\n``` \r\n\r\n``` \r\n\r\n## MCP File Service Syntax \r\n\r\n \r\n```txt\r\n/include all\r\n/include file=*.md\r\n/include pattern=*service*.js recursive\r\n/include dir=src pattern=*.py recursive\r\n```\r\n*Globs: `*`, `?`, character classes. No full regex.* \r\n\r\n---\r\n\r\n## MCP Server Startup \r\n\r\n```bash\r\npython robodog.py --folders c:\\projects\\robodog\\robodogcli --port 2500 --token testtoken --config config.yaml --model o4-mini\r\n``` \r\n\r\n---\r\n\r\n## Supported File Formats \r\n\r\n- Text & Markdown: `.txt`, `.md`, `.markdown` \r\n- Code: `.js`, `.ts`, `.py`, `.java`, `.c`, `.cpp`, `.go`, `.rs` \r\n- Config/Data: `.yaml`, `.yml`, `.json`, `.xml`, `.csv` \r\n- PDF: `.pdf` \r\n- Images: `.png`, `.jpg`, `.jpeg`, `.gif`, `.bmp`, `.tiff`, `.pbm`, `.pgm`, `.ppm` \r\n\r\n---\r\n\r\n## Command Reference \r\n\r\nRun `/help` in-app or see the list below: \r\n\r\n```\r\n/help \u2014 show help \r\n/model <name> \u2014 switch model \r\n/import \u2014 import files \r\n/export <filename> \u2014 export snapshot \r\n/clear \u2014 clear chat & knowledge \r\n/stash <name> \u2014 stash chat+knowledge \r\n/pop <name> \u2014 retrieve stash \r\n/list \u2014 list stashes \r\n/temperature <n> \u2014 set temperature (0\u20132) \r\n/max_tokens <n> \u2014 set max tokens \r\n/top_p <n> \u2014 set nucleus sampling \r\n/frequency_penalty <n> \u2014 set frequency penalty \r\n/presence_penalty <n> \u2014 set presence penalty \r\n/rest \u2014 use REST completions \r\n/stream \u2014 use streaming completions \r\n/include \u2026 \u2014 include files via MCP \r\n```\r\n\r\n*Also supports keyboard shortcuts:* \r\n- CTRL+SHIFT+UP to cycle stashes \r\n- CTRL+S to save a snapshot \r\n\r\n---\r\n\r\n## Indicators & Emojis \r\n\r\n- `[\ud83d\udcad]` Chat History \r\n- `[\ud83d\udcdd]` Knowledge Content \r\n- `[\ud83d\udcac]` Chat Text \r\n- `[\ud83d\udc7e]` User \r\n- `[\ud83e\udd16]` Assistant \r\n- `[\ud83d\udcbe]` System \r\n- `[\ud83d\udc0b/\ud83e\udd95/\ud83d\udc18/\ud83d\udc01]` Token usage levels \r\n- `[\ud83d\udc22/\ud83e\udd98/\ud83d\udc06/\ud83e\udd8c/\ud83d\udc15]` Performance (response time) \r\n\r\n---\r\n\r\n## Accessibility & PWA \r\n\r\n- Meets Section 508 and WCAG principles. \r\n- Detects standalone \u2265Installable as a PWA on supported devices. \r\n\r\n---\r\n\r\n## Build & Run \r\n\r\n```bash\r\n# Clone or unzip robodog\r\ncd robodog\r\npython build.py\r\n# Open in browser\r\nopen ./dist/robodog.html\r\n``` \r\n\r\nExperience the future of AI interaction\u2014fast, contextual, and extensible. Enjoy Robodog AI!\r\n",
"bugtrack_url": null,
"license": null,
"summary": "A short description of Robodog",
"version": "2.5.0",
"project_urls": {
"Documentation": "https://robodog.readthedocs.io",
"Homepage": "https://github.com/adourish/robodog",
"Repository": "https://github.com/adourish/robodog.git"
},
"split_keywords": [
"robot",
" dog",
" automation"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "b6d07afb26e14ae70ff47cb1c1cad8d69565d4ba509569afeda53f1d6216176a",
"md5": "08747240122ecf678235dfb10ea49fcd",
"sha256": "73da1b5d8216e71f15d8a6623f2c8a608a11f4c6d4b53f6f6100caba5a5c8f03"
},
"downloads": -1,
"filename": "sol9001_robodog-2.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "08747240122ecf678235dfb10ea49fcd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 14576,
"upload_time": "2025-08-24T02:58:40",
"upload_time_iso_8601": "2025-08-24T02:58:40.706816Z",
"url": "https://files.pythonhosted.org/packages/b6/d0/7afb26e14ae70ff47cb1c1cad8d69565d4ba509569afeda53f1d6216176a/sol9001_robodog-2.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "16dd1e64c3563a53c92a35254dd8047c4af5d8f23c185d00bcabcee34945ac3d",
"md5": "93aba693beb48c6033c5a54741076689",
"sha256": "9224b0ab7b034d436613cc4df59f1f59d0c6a54eff0fa76597e47d6e5c0ee6e1"
},
"downloads": -1,
"filename": "sol9001_robodog-2.5.0.tar.gz",
"has_sig": false,
"md5_digest": "93aba693beb48c6033c5a54741076689",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 17742,
"upload_time": "2025-08-24T02:58:42",
"upload_time_iso_8601": "2025-08-24T02:58:42.064879Z",
"url": "https://files.pythonhosted.org/packages/16/dd/1e64c3563a53c92a35254dd8047c4af5d8f23c185d00bcabcee34945ac3d/sol9001_robodog-2.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-24 02:58:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adourish",
"github_project": "robodog",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "sol9001-robodog"
}
