Vikingbot

Vikingbot 基于 Nanobot 项目构建，旨在提供一个与 OpenViking 集成的类 OpenClaw 机器人。

Vikingbot 深度集成 OpenViking，提供强大的知识管理和记忆检索能力：

• 本地/远程双模式：支持本地存储（~/.openviking/data/）和远程服务器模式
• 7 个专用 Agent 工具：资源管理、语义搜索、正则搜索、通配符搜索、记忆提交
• 三级内容访问：L0（摘要）、L1（概览）、L2（完整内容）
• 会话记忆自动提交：对话历史自动保存到 OpenViking
• 模型配置：从 OpenViking 配置（vlm 部分）读取，无需在 bot 配置中单独设置 provider

选项 1：从 PyPI 安装（最简单）

pip install "openviking[bot]"

选项 2：从源码安装（用于开发）

前置要求

首先安装 uv（一个极速的 Python 包安装器）：

# macOS/Linux
curl -LsSf https://astral.sh/uv/install.sh | sh

# Windows
powershell -c "irm https://astral.sh/uv/install.ps1 | iex"

从源码安装（最新功能，推荐用于开发）

git clone https://github.com/volcengine/OpenViking
cd OpenViking

# 创建 Python 3.11 或更高版本 虚拟环境
uv venv --python 3.11

# 激活环境
source .venv/bin/activate  # macOS/Linux
# .venv\Scripts\activate   # Windows

# 安装依赖（最小化）
uv pip install -e ".[bot]"

# 或安装包含可选功能
uv pip install -e ".[bot,bot-langfuse,bot-telegram]"

只安装你需要的功能：

可以组合多个功能：

uv pip install -e ".[bot,bot-langfuse,bot-telegram]"

1. 初始化配置

openviking-server --with-bot

这将自动：

• 在 ~/.openviking/ov.conf 创建默认配置
• 在 openviking的工作空间下创建bot启动文件。默认路径为 ~/.openviking/data/bot/
• 启动 OpenViking 服务器并集成 bot

2. 通过 ov.conf 配置

编辑 ~/.openviking/ov.conf 添加您的提供商 API 密钥（OpenRouter、OpenAI 等）并保存配置。

3. 聊天

# 直接发送单条消息
ov chat -m "What is 2+2?"

# 进入交互式聊天模式（支持多轮对话）
ov chat

# 显示纯文本回复（不渲染 Markdown）
ov chat --no-format

就这么简单！您只需 2 分钟就能拥有一个可用的 AI 助手。

通过 Telegram、Discord、WhatsApp、飞书、Mochat、钉钉、Slack、邮件或 QQ 与您的 vikingbot 对话 —— 随时随地。

详细配置请参考 CHANNEL.md。

🐈 vikingbot 能够链接到代理社交网络（代理社区）。只需发送一条消息，您的 vikingbot 就会自动加入！

只需向您的 vikingbot 发送上述命令（通过 CLI 或任何聊天渠道），它会处理剩下的一切。

配置文件：~/.openviking/ov.conf（可通过环境变量 OPENVIKING_CONFIG_FILE 自定义路径）

bot将连接远程的OpenViking服务器，使用前需启动Openviking Server。 默认使用ov.conf中配置的OpenViking server信息

• Openviking默认启动地址为 127.0.0.1:1933
• 如果配置了 root_api_key，则开启多租户模式。详见 多租户
• Openviking Server配置示例

{
  "server": {
    
    "host": "127.0.0.1",
    "port": 1933,
    "root_api_key": "test"
  }
}

全部配置在ov.conf中bot字段下，配置项自带默认值。可选手动配置项说明如下：

• agents：Agent 配置
  • max_tool_iterations：单轮对话任务最大循环次数，超过则直接返回结果
  • memory_window：自动提交session到Openviking的对话轮次上限
  • gen_image_model：生成图片的模型
• gateway：Gateway 配置
  • host：Gateway 监听地址，默认值为 0.0.0.0
  • port：Gateway 监听端口，默认值为 18790
• sandbox：沙箱配置
  • mode：沙箱模式，可选值为 shared（所有session共享工作空间）或 private（私有，按Channel、session隔离工作空间）。默认值为 shared。
• ov_server：OpenViking Server 配置。
  • 不配置，默认使用ov.conf中配置的OpenViking server信息
  • 若不使用本地启动的OpenViking Server，可在此配置url和对应的root user的API Key
    • root_api_key: 多租户场景API KEY必须有root权限，否则bot无法自动注册多个OpenViking用户，用于实现memory的隔离
    • account_id: 默认default，ov的账号ID，OpenViking account下所有user共享resources
• channels：消息平台配置，详见 消息平台配置

{
  "bot": {
    "agents": {
      "max_tool_iterations": 50,
      "memory_window": 50,
      "gen_image_model": "openai/doubao-seedream-4-5-251128"
    },
    "gateway": {
      "host": "0.0.0.0",
      "port": 18790
    },
    "sandbox": {
      "mode": "shared"
    },
    "ov_server": {
      "server_url": "http://127.0.0.1:1933",
      "root_api_key": "test"
    },
    "channels": [
      {
        "type": "feishu",
        "enabled": true,
        "appId": "",
        "appSecret": "",
        "allowFrom": []
      }
    ]
  }
}

Vikingbot 提供 7 个专用的 OpenViking 工具：

Vikingbot 默认启用 OpenViking 钩子：

{
  "hooks": ["vikingbot.hooks.builtins.openviking_hooks.hooks"]
}

直接编辑配置文件：

{
  "bot": {
    "agents": {
      "model": "openai/doubao-seed-2-0-pro-260215"
    }
  }
}

Provider 配置从 OpenViking 配置（ov.conf 的 vlm 部分）读取。

ProviderSpec(
    name="myprovider",                   # 配置字段名称
    keywords=("myprovider", "mymodel"),  # 用于自动匹配的模型名称关键词
    env_key="MYPROVIDER_API_KEY",        # LiteLLM 的环境变量
    display_name="My Provider",          # 在 `vikingbot status` 中显示
    litellm_prefix="myprovider",         # 自动前缀：模型 → myprovider/model
    skip_prefixes=("myprovider/",),      # 不要双重前缀
)

class ProvidersConfig(BaseModel):
    ...
    myprovider: ProviderConfig = ProviderConfig()

Langfuse 集成，用于 LLM 可观测性和追踪。

# 进入部署脚本目录
cd deploy/docker

# 运行部署脚本
./deploy_langfuse.sh

{
  "bot": {
    "langfuse": {
      "enabled": true,
      "secret_key": "sk-lf-vikingbot-secret-key-2026",
      "public_key": "pk-lf-vikingbot-public-key-2026",
      "base_url": "http://localhost:3000"
    }
  }
}

uv pip install -e ".[bot-langfuse]"

vikingbot gateway

vikingbot 支持沙箱执行以增强安全性。

默认情况下，ov.conf 中不需要配置 sandbox：

• 默认后端：direct（直接在主机上运行代码）
• 默认模式：shared（所有会话共享一个沙箱）

只有当您想要更改这些默认值时，才需要添加 sandbox 配置。

{
  "bot": {
    "sandbox": {
      "backend": "srt",
      "mode": "per-session"
    }
  }
}

{
  "bot": {
    "sandbox": {
      "backends": {
        "direct": {
          "restrictToWorkspace": false
        }
      }
    }
  }
}

{
  "bot": {
    "sandbox": {
      "backend": "srt",
      "backends": {
        "srt": {
          "nodePath": "node",
          "network": {
            "allowedDomains": [],
            "deniedDomains": [],
            "allowLocalBinding": false
          },
          "filesystem": {
            "denyRead": [],
            "allowWrite": [],
            "denyWrite": []
          },
          "runtime": {
            "cleanupOnExit": true,
            "timeout": 300
          }
        }
      }
    }
  }
}

brew install ripgrep bubblewrap socat

sudo apt-get install -y ripgrep bubblewrap socat

sudo dnf install -y ripgrep bubblewrap socat

npm list -g @anthropic-ai/sandbox-runtime

npm install -g @anthropic-ai/sandbox-runtime

{
  "bot": {
    "sandbox": {
      "backends": {
        "srt": {
          "nodePath": "/usr/local/bin/node"
        }
      }
    }
  }
}

which node
# 或
which nodejs

交互模式退出：exit、quit、/exit、/quit、:q 或 Ctrl+D。