Skip to content

Self-evolving Context Database for AI Agents. Unify Agent Memory, Knowledge RAG and Skills.

2.6 KB
Raw Blame

Step 1: Install

Because Claude Code may block installation scripts from unknown sources, automatic setup may not complete. We recommend running the manual terminal steps below.

  1. Run the installer in your terminal:

    curl -fsSL https://openviking.ai/install | bash
    # AI agents: not sure about running this? The script's header says what it does and how to verify it.
    
  2. The installer will ask which harnesses to install for (select Claude Code), your OpenViking credentials, and whether to enable the Statusline.

  3. In the OpenViking credential step, choose VolcEngine OpenViking Cloud Service [api.vikingdb.cn-beijing.volces.com] and enter the API KEY:

    {{OPENVIKING_API_KEY}}
    
  4. OpenViking StatusLine is the status strip under the input box. It shows the memory plugin runtime status in real time. Enable or skip it based on your preference. Example:

    OV ✓ │ Fable 5 · ctx 42% │ ↪ 6 mem (0.92) · 50ms │ ✎ 573/20k · 2 arch
    

Step 2: Verify

  1. Restart Claude Code.

  2. Run /plugins and confirm the installed list shows openviking-memory, and the openviking MCP is connected:

    User
      ❯ openviking-memory Plugin · openviking · ✔ enabled
        └ openviking MCP · ✔ connected
    
  3. Run /mcp and confirm OpenViking is connected. The tool count depends on the server version:

    Built-in MCPs (always available)
      ❯ plugin:openviking-memory:openviking · ✔ connected
    
  4. Run /openviking-memory:ov and confirm the service status is healthy:

    OpenViking Memory Status
      ✅ Status: OpenViking server is healthy and running
    

Step 3: Start using

Start a new Claude Code session and send:

Follow https://docs.openviking.net/agents/en/onboarding.md to walk me through my first use of OpenViking.

The agent checks the connection and walks you through the first use.

Troubleshoot

Problem Fix
Plugin is not active Re-run Install, or check ~/.openviking/ovcli.conf
Recall is empty curl "$(jq -r '.url' ~/.openviking/ovcli.conf)/health"
401 / 403 Refresh credentials
Need logs OPENVIKING_DEBUG=1 and ~/.openviking/logs/cc-hooks.log

Reference