SMARAN.AI Documentation
How to install SMARAN.AI, what each part does, and where your data is kept - on Windows, Linux and Android.
On this page
01 Quickstart Overview
SMARAN.AI is a personal assistant that runs on your own computer. It can run open models locally through Ollama, so a conversation with a local model never leaves your machine. When you want a bigger model, you can add a key for a cloud provider - then that request goes to that provider.
Your chats, documents, memory and API keys are stored in your own user folder. Nothing you type is sent anywhere unless you pick a cloud model, switch on web search, or use the Gemini voice engine.
🖥️ Desktop app
Windows from the Microsoft Store (signed by Microsoft so SmartScreen and Smart App Control let it run), and Linux from the Ubuntu Snap Store (sudo snap install smaran-ai), plus .deb, .rpm or .tar.gz packages for Ubuntu, Kali Linux, Debian, Fedora, Arch and RHEL. Python is bundled; local models need Ollama, which the app can install for you.
📱 Android app
Works on its own — even without an account or API key, or with a free Gemini, Groq or OpenRouter key — and links to your PC for local models, your documents and PC control.
⚡ VS Code extension
SMARAN.AI Codex (v2.31.0): ask about the open file, propose edits, run commands, and test local web apps in its built-in Browser tab, with a local model or your own cloud key.
02 Hardware Requirements
The app itself runs on any 64-bit Windows 10/11 PC, or Linux x86-64 with glibc 2.28 or newer. What you need beyond that depends on which model you run. Every model in the Model Hub shows its memory requirement before you download it: across the 63 models in the catalogue it runs from 4 GB to 512 GB, and 18 of them need 8 GB or less.
- A GPU makes local models faster; it is not required.
- Cloud models need no particular hardware - only a key and a connection.
- A webcam only if you want vision from the camera.
03 Installation Steps
Download from the download section. On Windows, install from the Microsoft Store, which is signed by Microsoft so SmartScreen and Smart App Control let it run and update automatically. Step-by-step instructions for each platform are in the install guide.
sudo snap install smaran-ai
curl.exe -L -o smaran.exe https://github.com/SHASHWAT-MISHRA-997/SMARAN.AI-downloads/releases/latest/download/smaran.exe
curl -L -o smaran https://github.com/SHASHWAT-MISHRA-997/SMARAN.AI-downloads/releases/latest/download/smaran-linux-x86_64
chmod +x smaran && sudo mv smaran /usr/local/bin/
04 Model Hub
The Model Hub lists 63 models, filtered by what they are good at - reasoning, vision, code, text, audio, video — plus a built-in HuggingFace GGUF Hub tab to search and pull quantized GGUF models directly into Ollama. It keeps three things apart: a model that is only in the catalogue, one you have downloaded, and one that is actually running.
Local models
Downloaded through Ollama or pulled from HuggingFace GGUF Hub and kept on your drive. They cost nothing to run and work offline.
Cloud models
Add a key for a provider such as Gemini, Groq, OpenRouter, Cerebras, Mistral, DeepSeek, OpenAI or Anthropic. Remove any provider from Settings → Model Matrix; a deleted local model stays deleted. Keys are checked before saving, and when no model answers, SMARAN tells you honestly instead of making up a reply.
Pictures, video & music
In the free cloud: zero-key FLUX on Hugging Face (free AI Horde as backup) or a free NVIDIA FLUX key for pictures; Wan 2.2 or LTX-Video on Hugging Face's shared GPUs for short video (with 5/10/15s continuation from the last frame); and Lyria or MusicGen (plus a local PC synthesizer) for music.
05 SMARAN Code
SMARAN Code works on a project folder with repo_map, multi_edit, and run_python:
it maps files, makes atomic multi-file edits, runs commands and tests, opens local web apps in its built-in browser to read console/page errors and verify UI changes, and fixes what fails. Approvals are Manual, Smart or Off, and a whole run can be undone.
Configure execution filtering & timeouts in Settings → Sandbox & Security (STRICT, PERMISSIVE, or OFF), test desktop automation & emergency stop in Settings → Capabilities, and undo any file edit run in one click. (This filters commands and creates checkpoints rather than full OS container virtualization.)
06 Voice & Speech
The live voice call has two engines:
- Local: faster-whisper hears you, a local model answers, Kokoro speaks - all on this machine, with the network off. Kokoro speaks English; other languages use an online voice.
- Reading a reply aloud (Speak): English is spoken by Kokoro on this machine. Other languages use Microsoft's online voice, so for those the reply's text is sent to Microsoft.
- Gemini: Google's live voice, which can also see your screen or camera. It needs a Gemini key, and your audio goes to Google while the call is open.
The wake word: on the phone "Hey SMARAN", "Hey Jarvis", "Hey Amarya" and "Hey Myra" are all heard offline; on the PC "Hey SMARAN" and "Hey Jarvis" are heard offline.
07 Drive, Studio, Dots, Mail & Team
Everything SMARAN creates lives in Drive, alongside rich workspaces for documents, presentations, spreadsheets, autonomous helpers, mail, and Wi-Fi collaboration.
🎨 Design Studio & Sites
Generate a page or component from a sentence in HTML, CSS and JavaScript with a live preview, keep refining it, or download it as an HTML file.
📄 Pages, Slides, Sheets & Podcasts
Write Pages (with Record meeting transcription & Enhance notes without a bot joining the call), build Slides (.pptx export), create Sheets with a Dashboard summary (.xlsx export), and generate Two-Host Podcasts.
🤖 Dots, Mail & Team
Run specialist Dots (Researcher, Monitor, Writer, Developer) with their own browser profiles on a schedule, webhook or email trigger; read and draft in a Gmail-style IMAP/SMTP Mail inbox; and share the assistant over Wi-Fi in Team.
📊 Executive Dashboards & CRM
A real sales pipeline saved on your PC: deals across Lead → Qualified → Proposal → Negotiation → Won/Lost, live KPIs (pipeline value, won revenue, win rate, average deal), follow-up tasks, a WhatsApp follow-up button and .xlsx export. Open it from Dashboards & CRM on the home screen.
💬 2-Way WhatsApp, Telegram & Slack
Settings → Integrations & Gateways. Click Connect WhatsApp to scan the official Linked Devices QR right inside SMARAN.AI for automatic 2-way replies in Message Yourself, @smaran, and /task (or all unread 1:1 DMs), plus direct messaging — alongside Telegram and Slack bots.
Choose Drive, Pages, Dots, Mail, Team, or Design Studio (under Sites) in the sidebar of the desktop app.
08 VS Code Extension
SMARAN.AI Codex (v2.31.0) works beside your code in VS Code. It talks to the SMARAN.AI desktop app, a local model server
(Ollama or LM Studio), or a cloud provider with your own key. Files it reads are sent to the model you chose.
💬 Ask, edit & test
Explain or refactor the open file, write tests, or open your local dev server in the built-in Browser tab to check console errors and click through the UI.
🛡️ You choose its reach
Read-only, workspace or full access, and approval for every action, only commands, only risky ones, or none.
🎙️ Dictation
Dictate a prompt instead of typing it.
Search "SMARAN.AI Codex" in the Extensions view, or run ext install ShashwatMishra.smaran-ai-codex from the command palette (Ctrl+P).
{
"smaran.provider": "",
"smaran.model": "",
"smaran.ollamaUrl": "http://localhost:11434",
"smaran.reach": "workspace",
"smaran.approval": "always"
}
09 Android App & Linking Your PC
The phone app works on its own. Linking it to your PC adds shared history, your PC's local models and documents, and control of the PC from the phone:
- On the PC, open Settings and choose Link your phone. A QR code appears.
- On the phone, choose Link a computer and scan it - or type the pairing code shown under it.
- Both devices now use one account and one history. Unlink from either side at any time.
Only a fixed set of actions can be asked of the PC from the phone, and anything about money, buying or the power button still asks you first.
10 Where Your Data Lives
Everything the app keeps is in one folder. Deleting it deletes your chats, memory, keys and settings.
| System | Folder |
|---|---|
| Windows | %LOCALAPPDATA%\SMARAN.AI\data |
| Linux | ~/.local/share/SMARAN.AI/data (or $XDG_DATA_HOME/SMARAN.AI/data) |
| Android | The app's own private storage; removed when the app is uninstalled. |
Downloaded local models are kept by Ollama in its own folder.
11 Privacy & What Is Sent
- Cloud models: when you choose one, your message and the context it needs go to that provider.
- Web search: only when you switch it on.
- Reading a reply aloud: English stays here (Kokoro); other languages go to Microsoft's voice service.
- Gemini voice: your microphone audio (and screen or camera, if you turn them on) goes to Google while the call is open.
- Usage data: none. The app sends no install id, no launch or usage counts and no reports of any kind.
- This website: counts visits and download clicks (an event name only, no personal data), plus anything you type into the feedback form.
See also the Terms of Service and the privacy summary.