Skip to content

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

2.8 KB
Raw Blame

Step 1: Install

  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 Codex) and for OpenViking credentials. In the OpenViking credential step, choose VolcEngine OpenViking Cloud Service [api.vikingdb.cn-beijing.volces.com] and enter the API KEY:

    {{OPENVIKING_API_KEY}}
    

Step 2: Verify

  1. Start Codex. The first launch shows a hook review prompt similar to this (exact layout varies by version); pick Trust all and continue:

    Hooks need review
    6 hooks are new or changed.
    Hooks can run outside the sandbox after you trust them.
    
      1. Review hooks
    > 2. Trust all and continue
      3. Continue without trusting (hooks won't run)
    

    If you skipped it or picked option 3, open /hooks. Review the OpenViking commands, then trust and enable the hooks you intend to use. In /plugins, confirm that openviking-memory is enabled. New or changed hooks require another review.

  2. Confirm that OpenViking MCP tools are available, then ask Codex to call health and list. This verifies tool access; automatic recall also requires UserPromptSubmit, and capture requires Stop.

  3. In a workspace with saved memories, ask about previously stored information and check the hook output or debug log. Recalled context looks similar to this:

    • UserPromptSubmit hook (completed)
      hook context: <openviking-context source="auto-recall" format="digest">
        OpenViking memory digest:
    

    An empty new account may have no profile or relevant memories to inject. See the full guide for lifecycle commits and a complete memory check.

Step 3: Start using

Start a new Codex 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
Auth error Check api_key in ~/.openviking/ovcli.conf, restart Codex
Connection error curl "$(jq -r '.url' ~/.openviking/ovcli.conf)/health"
6 hooks need review, or no hook fires Trust and enable in /hooks; confirm the plugin is enabled in /plugins
Need logs OPENVIKING_DEBUG=1 and ~/.openviking/logs/codex-hooks.log

Reference