milaidy 1.0.0

package/docs/providers/venice.md

@@ -0,0 +1,267 @@
+---
+summary: "Use Venice AI privacy-focused models in Milaidy"
+read_when:
+  - You want privacy-focused inference in Milaidy
+  - You want Venice AI setup guidance
+title: "Venice AI"
+---
+
+# Venice AI (Venice highlight)
+
+**Venice** is our highlight Venice setup for privacy-first inference with optional anonymized access to proprietary models.
+
+Venice AI provides privacy-focused AI inference with support for uncensored models and access to major proprietary models through their anonymized proxy. All inference is private by default—no training on your data, no logging.
+
+## Why Venice in Milaidy
+
+- **Private inference** for open-source models (no logging).
+- **Uncensored models** when you need them.
+- **Anonymized access** to proprietary models (Opus/GPT/Gemini) when quality matters.
+- OpenAI-compatible `/v1` endpoints.
+
+## Privacy Modes
+
+Venice offers two privacy levels — understanding this is key to choosing your model:
+
+| Mode           | Description                                                                                                          | Models                                         |
+| -------------- | -------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------- |
+| **Private**    | Fully private. Prompts/responses are **never stored or logged**. Ephemeral.                                          | Llama, Qwen, DeepSeek, Venice Uncensored, etc. |
+| **Anonymized** | Proxied through Venice with metadata stripped. The underlying provider (OpenAI, Anthropic) sees anonymized requests. | Claude, GPT, Gemini, Grok, Kimi, MiniMax       |
+
+## Features
+
+- **Privacy-focused**: Choose between "private" (fully private) and "anonymized" (proxied) modes
+- **Uncensored models**: Access to models without content restrictions
+- **Major model access**: Use Claude, GPT-5.2, Gemini, Grok via Venice's anonymized proxy
+- **OpenAI-compatible API**: Standard `/v1` endpoints for easy integration
+- **Streaming**: ✅ Supported on all models
+- **Function calling**: ✅ Supported on select models (check model capabilities)
+- **Vision**: ✅ Supported on models with vision capability
+- **No hard rate limits**: Fair-use throttling may apply for extreme usage
+
+## Setup
+
+### 1. Get API Key
+
+1. Sign up at [venice.ai](https://venice.ai)
+2. Go to **Settings → API Keys → Create new key**
+3. Copy your API key (format: `vapi_xxxxxxxxxxxx`)
+
+### 2. Configure Milaidy
+
+**Option A: Environment Variable**
+
+```bash
+export VENICE_API_KEY="vapi_xxxxxxxxxxxx"
+```
+
+**Option B: Interactive Setup (Recommended)**
+
+```bash
+milaidy onboard --auth-choice venice-api-key
+```
+
+This will:
+
+1. Prompt for your API key (or use existing `VENICE_API_KEY`)
+2. Show all available Venice models
+3. Let you pick your default model
+4. Configure the provider automatically
+
+**Option C: Non-interactive**
+
+```bash
+milaidy onboard --non-interactive \
+  --auth-choice venice-api-key \
+  --venice-api-key "vapi_xxxxxxxxxxxx"
+```
+
+### 3. Verify Setup
+
+```bash
+milaidy chat --model venice/llama-3.3-70b "Hello, are you working?"
+```
+
+## Model Selection
+
+After setup, Milaidy shows all available Venice models. Pick based on your needs:
+
+- **Default (our pick)**: `venice/llama-3.3-70b` for private, balanced performance.
+- **Best overall quality**: `venice/claude-opus-45` for hard jobs (Opus remains the strongest).
+- **Privacy**: Choose "private" models for fully private inference.
+- **Capability**: Choose "anonymized" models to access Claude, GPT, Gemini via Venice's proxy.
+
+Change your default model anytime:
+
+```bash
+milaidy models set venice/claude-opus-45
+milaidy models set venice/llama-3.3-70b
+```
+
+List all available models:
+
+```bash
+milaidy models list | grep venice
+```
+
+## Configure via `milaidy configure`
+
+1. Run `milaidy configure`
+2. Select **Model/auth**
+3. Choose **Venice AI**
+
+## Which Model Should I Use?
+
+| Use Case                     | Recommended Model                | Why                                       |
+| ---------------------------- | -------------------------------- | ----------------------------------------- |
+| **General chat**             | `llama-3.3-70b`                  | Good all-around, fully private            |
+| **Best overall quality**     | `claude-opus-45`                 | Opus remains the strongest for hard tasks |
+| **Privacy + Claude quality** | `claude-opus-45`                 | Best reasoning via anonymized proxy       |
+| **Coding**                   | `qwen3-coder-480b-a35b-instruct` | Code-optimized, 262k context              |
+| **Vision tasks**             | `qwen3-vl-235b-a22b`             | Best private vision model                 |
+| **Uncensored**               | `venice-uncensored`              | No content restrictions                   |
+| **Fast + cheap**             | `qwen3-4b`                       | Lightweight, still capable                |
+| **Complex reasoning**        | `deepseek-v3.2`                  | Strong reasoning, private                 |
+
+## Available Models (25 Total)
+
+### Private Models (15) — Fully Private, No Logging
+
+| Model ID                         | Name                    | Context (tokens) | Features                |
+| -------------------------------- | ----------------------- | ---------------- | ----------------------- |
+| `llama-3.3-70b`                  | Llama 3.3 70B           | 131k             | General                 |
+| `llama-3.2-3b`                   | Llama 3.2 3B            | 131k             | Fast, lightweight       |
+| `hermes-3-llama-3.1-405b`        | Hermes 3 Llama 3.1 405B | 131k             | Complex tasks           |
+| `qwen3-235b-a22b-thinking-2507`  | Qwen3 235B Thinking     | 131k             | Reasoning               |
+| `qwen3-235b-a22b-instruct-2507`  | Qwen3 235B Instruct     | 131k             | General                 |
+| `qwen3-coder-480b-a35b-instruct` | Qwen3 Coder 480B        | 262k             | Code                    |
+| `qwen3-next-80b`                 | Qwen3 Next 80B          | 262k             | General                 |
+| `qwen3-vl-235b-a22b`             | Qwen3 VL 235B           | 262k             | Vision                  |
+| `qwen3-4b`                       | Venice Small (Qwen3 4B) | 32k              | Fast, reasoning         |
+| `deepseek-v3.2`                  | DeepSeek V3.2           | 163k             | Reasoning               |
+| `venice-uncensored`              | Venice Uncensored       | 32k              | Uncensored              |
+| `mistral-31-24b`                 | Venice Medium (Mistral) | 131k             | Vision                  |
+| `google-gemma-3-27b-it`          | Gemma 3 27B Instruct    | 202k             | Vision                  |
+| `openai-gpt-oss-120b`            | OpenAI GPT OSS 120B     | 131k             | General                 |
+| `zai-org-glm-4.7`                | GLM 4.7                 | 202k             | Reasoning, multilingual |
+
+### Anonymized Models (10) — Via Venice Proxy
+
+| Model ID                 | Original          | Context (tokens) | Features          |
+| ------------------------ | ----------------- | ---------------- | ----------------- |
+| `claude-opus-45`         | Claude Opus 4.5   | 202k             | Reasoning, vision |
+| `claude-sonnet-45`       | Claude Sonnet 4.5 | 202k             | Reasoning, vision |
+| `openai-gpt-52`          | GPT-5.2           | 262k             | Reasoning         |
+| `openai-gpt-52-codex`    | GPT-5.2 Codex     | 262k             | Reasoning, vision |
+| `gemini-3-pro-preview`   | Gemini 3 Pro      | 202k             | Reasoning, vision |
+| `gemini-3-flash-preview` | Gemini 3 Flash    | 262k             | Reasoning, vision |
+| `grok-41-fast`           | Grok 4.1 Fast     | 262k             | Reasoning, vision |
+| `grok-code-fast-1`       | Grok Code Fast 1  | 262k             | Reasoning, code   |
+| `kimi-k2-thinking`       | Kimi K2 Thinking  | 262k             | Reasoning         |
+| `minimax-m21`            | MiniMax M2.1      | 202k             | Reasoning         |
+
+## Model Discovery
+
+Milaidy automatically discovers models from the Venice API when `VENICE_API_KEY` is set. If the API is unreachable, it falls back to a static catalog.
+
+The `/models` endpoint is public (no auth needed for listing), but inference requires a valid API key.
+
+## Streaming & Tool Support
+
+| Feature              | Support                                                 |
+| -------------------- | ------------------------------------------------------- |
+| **Streaming**        | ✅ All models                                           |
+| **Function calling** | ✅ Most models (check `supportsFunctionCalling` in API) |
+| **Vision/Images**    | ✅ Models marked with "Vision" feature                  |
+| **JSON mode**        | ✅ Supported via `response_format`                      |
+
+## Pricing
+
+Venice uses a credit-based system. Check [venice.ai/pricing](https://venice.ai/pricing) for current rates:
+
+- **Private models**: Generally lower cost
+- **Anonymized models**: Similar to direct API pricing + small Venice fee
+
+## Comparison: Venice vs Direct API
+
+| Aspect       | Venice (Anonymized)           | Direct API          |
+| ------------ | ----------------------------- | ------------------- |
+| **Privacy**  | Metadata stripped, anonymized | Your account linked |
+| **Latency**  | +10-50ms (proxy)              | Direct              |
+| **Features** | Most features supported       | Full features       |
+| **Billing**  | Venice credits                | Provider billing    |
+
+## Usage Examples
+
+```bash
+# Use default private model
+milaidy chat --model venice/llama-3.3-70b
+
+# Use Claude via Venice (anonymized)
+milaidy chat --model venice/claude-opus-45
+
+# Use uncensored model
+milaidy chat --model venice/venice-uncensored
+
+# Use vision model with image
+milaidy chat --model venice/qwen3-vl-235b-a22b
+
+# Use coding model
+milaidy chat --model venice/qwen3-coder-480b-a35b-instruct
+```
+
+## Troubleshooting
+
+### API key not recognized
+
+```bash
+echo $VENICE_API_KEY
+milaidy models list | grep venice
+```
+
+Ensure the key starts with `vapi_`.
+
+### Model not available
+
+The Venice model catalog updates dynamically. Run `milaidy models list` to see currently available models. Some models may be temporarily offline.
+
+### Connection issues
+
+Venice API is at `https://api.venice.ai/api/v1`. Ensure your network allows HTTPS connections.
+
+## Config file example
+
+```json5
+{
+  env: { VENICE_API_KEY: "vapi_..." },
+  agents: { defaults: { model: { primary: "venice/llama-3.3-70b" } } },
+  models: {
+    mode: "merge",
+    providers: {
+      venice: {
+        baseUrl: "https://api.venice.ai/api/v1",
+        apiKey: "${VENICE_API_KEY}",
+        api: "openai-completions",
+        models: [
+          {
+            id: "llama-3.3-70b",
+            name: "Llama 3.3 70B",
+            reasoning: false,
+            input: ["text"],
+            cost: { input: 0, output: 0, cacheRead: 0, cacheWrite: 0 },
+            contextWindow: 131072,
+            maxTokens: 8192,
+          },
+        ],
+      },
+    },
+  },
+}
+```
+
+## Links
+
+- [Venice AI](https://venice.ai)
+- [API Documentation](https://docs.venice.ai)
+- [Pricing](https://venice.ai/pricing)
+- [Status](https://status.venice.ai)

package/docs/providers/vercel-ai-gateway.md

@@ -0,0 +1,50 @@
+---
+title: "Vercel AI Gateway"
+summary: "Vercel AI Gateway setup (auth + model selection)"
+read_when:
+  - You want to use Vercel AI Gateway with Milaidy
+  - You need the API key env var or CLI auth choice
+---
+
+# Vercel AI Gateway
+
+The [Vercel AI Gateway](https://vercel.com/ai-gateway) provides a unified API to access hundreds of models through a single endpoint.
+
+- Provider: `vercel-ai-gateway`
+- Auth: `AI_GATEWAY_API_KEY`
+- API: Anthropic Messages compatible
+
+## Quick start
+
+1. Set the API key (recommended: store it for the Gateway):
+
+```bash
+milaidy onboard --auth-choice ai-gateway-api-key
+```
+
+2. Set a default model:
+
+```json5
+{
+  agents: {
+    defaults: {
+      model: { primary: "vercel-ai-gateway/anthropic/claude-opus-4.5" },
+    },
+  },
+}
+```
+
+## Non-interactive example
+
+```bash
+milaidy onboard --non-interactive \
+  --mode local \
+  --auth-choice ai-gateway-api-key \
+  --ai-gateway-api-key "$AI_GATEWAY_API_KEY"
+```
+
+## Environment note
+
+If the Gateway runs as a daemon (launchd/systemd), make sure `AI_GATEWAY_API_KEY`
+is available to that process (for example, in `~/.milaidy/.env` or via
+`env.shellEnv`).

package/docs/providers/xiaomi.md

@@ -0,0 +1,64 @@
+---
+summary: "Use Xiaomi MiMo (mimo-v2-flash) with Milaidy"
+read_when:
+  - You want Xiaomi MiMo models in Milaidy
+  - You need XIAOMI_API_KEY setup
+title: "Xiaomi MiMo"
+---
+
+# Xiaomi MiMo
+
+Xiaomi MiMo is the API platform for **MiMo** models. It provides REST APIs compatible with
+OpenAI and Anthropic formats and uses API keys for authentication. Create your API key in
+the [Xiaomi MiMo console](https://platform.xiaomimimo.com/#/console/api-keys). Milaidy uses
+the `xiaomi` provider with a Xiaomi MiMo API key.
+
+## Model overview
+
+- **mimo-v2-flash**: 262144-token context window, Anthropic Messages API compatible.
+- Base URL: `https://api.xiaomimimo.com/anthropic`
+- Authorization: `Bearer $XIAOMI_API_KEY`
+
+## CLI setup
+
+```bash
+milaidy onboard --auth-choice xiaomi-api-key
+# or non-interactive
+milaidy onboard --auth-choice xiaomi-api-key --xiaomi-api-key "$XIAOMI_API_KEY"
+```
+
+## Config snippet
+
+```json5
+{
+  env: { XIAOMI_API_KEY: "your-key" },
+  agents: { defaults: { model: { primary: "xiaomi/mimo-v2-flash" } } },
+  models: {
+    mode: "merge",
+    providers: {
+      xiaomi: {
+        baseUrl: "https://api.xiaomimimo.com/anthropic",
+        api: "anthropic-messages",
+        apiKey: "XIAOMI_API_KEY",
+        models: [
+          {
+            id: "mimo-v2-flash",
+            name: "Xiaomi MiMo V2 Flash",
+            reasoning: false,
+            input: ["text"],
+            cost: { input: 0, output: 0, cacheRead: 0, cacheWrite: 0 },
+            contextWindow: 262144,
+            maxTokens: 8192,
+          },
+        ],
+      },
+    },
+  },
+}
+```
+
+## Notes
+
+- Model ref: `xiaomi/mimo-v2-flash`.
+- The provider is injected automatically when `XIAOMI_API_KEY` is set (or an auth profile exists).
+- See [/concepts/model-providers](/concepts/model-providers) for provider rules.

package/docs/providers/zai.md

@@ -0,0 +1,36 @@
+---
+summary: "Use Z.AI (GLM models) with Milaidy"
+read_when:
+  - You want Z.AI / GLM models in Milaidy
+  - You need a simple ZAI_API_KEY setup
+title: "Z.AI"
+---
+
+# Z.AI
+
+Z.AI is the API platform for **GLM** models. It provides REST APIs for GLM and uses API keys
+for authentication. Create your API key in the Z.AI console. Milaidy uses the `zai` provider
+with a Z.AI API key.
+
+## CLI setup
+
+```bash
+milaidy onboard --auth-choice zai-api-key
+# or non-interactive
+milaidy onboard --zai-api-key "$ZAI_API_KEY"
+```
+
+## Config snippet
+
+```json5
+{
+  env: { ZAI_API_KEY: "sk-..." },
+  agents: { defaults: { model: { primary: "zai/glm-4.7" } } },
+}
+```
+
+## Notes
+
+- GLM models are available as `zai/<model>` (example: `zai/glm-4.7`).
+- See [/providers/glm](/providers/glm) for the model family overview.
+- Z.AI uses Bearer auth with your API key.

package/docs/railway.mdx

@@ -0,0 +1,99 @@
+---
+title: Deploy on Railway
+---
+
+Deploy Milaidy on Railway with a one-click template and finish setup in your browser.
+This is the easiest “no terminal on the server” path: Railway runs the Gateway for you,
+and you configure everything via the `/setup` web wizard.
+
+## Quick checklist (new users)
+
+1. Click **Deploy on Railway** (below).
+2. Add a **Volume** mounted at `/data`.
+3. Set the required **Variables** (at least `SETUP_PASSWORD`).
+4. Enable **HTTP Proxy** on port `8080`.
+5. Open `https://<your-railway-domain>/setup` and finish the wizard.
+
+## One-click deploy
+
+<a href="https://railway.com/deploy/milaidy-railway-template" target="_blank" rel="noreferrer">
+  Deploy on Railway
+</a>
+
+After deploy, find your public URL in **Railway → your service → Settings → Domains**.
+
+Railway will either:
+
+- give you a generated domain (often `https://<something>.up.railway.app`), or
+- use your custom domain if you attached one.
+
+Then open:
+
+- `https://<your-railway-domain>/setup` — setup wizard (password protected)
+- `https://<your-railway-domain>/milaidy` — Control UI
+
+## What you get
+
+- Hosted Milaidy Gateway + Control UI
+- Web setup wizard at `/setup` (no terminal commands)
+- Persistent storage via Railway Volume (`/data`) so config/credentials/workspace survive redeploys
+- Backup export at `/setup/export` to migrate off Railway later
+
+## Required Railway settings
+
+### Public Networking
+
+Enable **HTTP Proxy** for the service.
+
+- Port: `8080`
+
+### Volume (required)
+
+Attach a volume mounted at:
+
+- `/data`
+
+### Variables
+
+Set these variables on the service:
+
+- `SETUP_PASSWORD` (required)
+- `PORT=8080` (required — must match the port in Public Networking)
+- `MILAIDY_STATE_DIR=/data/.milaidy` (recommended)
+- `MILAIDY_WORKSPACE_DIR=/data/workspace` (recommended)
+- `MILAIDY_GATEWAY_TOKEN` (recommended; treat as an admin secret)
+
+## Setup flow
+
+1. Visit `https://<your-railway-domain>/setup` and enter your `SETUP_PASSWORD`.
+2. Choose a model/auth provider and paste your key.
+3. (Optional) Add Telegram/Discord/Slack tokens.
+4. Click **Run setup**.
+
+If Telegram DMs are set to pairing, the setup wizard can approve the pairing code.
+
+## Getting chat tokens
+
+### Telegram bot token
+
+1. Message `@BotFather` in Telegram
+2. Run `/newbot`
+3. Copy the token (looks like `123456789:AA...`)
+4. Paste it into `/setup`
+
+### Discord bot token
+
+1. Go to https://discord.com/developers/applications
+2. **New Application** → choose a name
+3. **Bot** → **Add Bot**
+4. **Enable MESSAGE CONTENT INTENT** under Bot → Privileged Gateway Intents (required or the bot will crash on startup)
+5. Copy the **Bot Token** and paste into `/setup`
+6. Invite the bot to your server (OAuth2 URL Generator; scopes: `bot`, `applications.commands`)
+
+## Backups & migration
+
+Download a backup at:
+
+- `https://<your-railway-domain>/setup/export`
+
+This exports your Milaidy state + workspace so you can migrate to another host without losing config or memory.

package/docs/reference/templates/AGENTS.md

@@ -0,0 +1,9 @@
+# Agent Guidelines
+
+You are Milaidy, a helpful AI assistant. Follow user instructions carefully and provide clear, accurate responses.
+
+## Behavior
+
+- Be helpful, concise, and accurate.
+- When unsure, say so rather than guessing.
+- Follow the user's preferred communication style.

package/docs/reference/templates/BOOTSTRAP.md

@@ -0,0 +1,3 @@
+# Bootstrap
+
+Initial workspace setup complete. The agent is ready.

package/docs/reference/templates/HEARTBEAT.md

@@ -0,0 +1,3 @@
+# Heartbeat
+
+Periodic check-in template for the agent runtime.

package/docs/reference/templates/IDENTITY.md

@@ -0,0 +1,3 @@
+# Identity
+
+You are Milaidy, a personal AI assistant running on ElizaOS.

package/docs/reference/templates/TOOLS.md

@@ -0,0 +1,3 @@
+# Tools
+
+Available tools are provided by the runtime plugins. Use them when appropriate to help the user.

package/docs/reference/templates/USER.md

@@ -0,0 +1,3 @@
+# User
+
+The user is the owner of this Milaidy instance.