Self-evolving Context Database for AI Agents. Unify Agent Memory, Knowledge RAG and Skills.
Python agent-contextagent-memoryagent-pluginsagentic-ragcontext-databasedsh-pluginknowledge-basememorymemory-managementself-evolvingvector-database
Refactor README structure and update section headings (#2505)
Lumos08882666f891e91
diff --git a/README.md b/README.mdindex 85f738ce8..281e9b1ee 100644--- a/README.md+++ b/README.md@@ -59,7 +59,9 @@ With OpenViking, developers can build an Agent's brain just like managing local## Quick Start-### Prerequisites+### Local Deployment++#### PrerequisitesBefore starting with OpenViking, please ensure your environment meets the following requirements:@@ -69,15 +71,15 @@ Before starting with OpenViking, please ensure your environment meets the follow- **Operating System**: Linux, macOS, Windows- **Network Connection**: A stable network connection is required (for downloading dependencies and accessing model services)-### 1. Installation+#### 1. Installation-#### Python Package+##### Python Package```bashpip install openviking --upgrade --force-reinstall```-#### Rust CLI (Optional)+##### Rust CLI (Optional)```bashnpm i -g @openviking/cli@@ -89,14 +91,14 @@ Or build from source:cargo install --git https://github.com/volcengine/OpenViking ov_cli```-### 2. Model Preparation+#### 2. Model PreparationOpenViking requires the following model capabilities:- **VLM Model**: For image and content understanding- **Embedding Model**: For vectorization and semantic retrieval-#### Supported VLM Providers+##### Supported VLM ProvidersOpenViking supports multiple VLM providers:@@ -108,7 +110,7 @@ OpenViking supports multiple VLM providers:| `kimi` | Kimi Code Membership | Use `openviking-server init` || `glm` | GLM Coding Plan | Use `openviking-server init` |-#### Provider-Specific Notes+##### Provider-Specific Notes<details><summary><b>Volcengine (Doubao)</b></summary>@@ -267,9 +269,9 @@ openviking-server doctor</details>-### 3. Environment Configuration+#### 3. Environment Configuration-#### Quick Setup for Local Models (Ollama)+##### Quick Setup for Local Models (Ollama)If you want to run OpenViking with local models via [Ollama](https://ollama.ai), the interactive setup wizard handles everything automatically:@@ -293,7 +295,7 @@ openviking-server doctor> For cloud API providers (Volcengine, OpenAI, Gemini, etc.), continue with the manual configuration below.-#### Server Configuration Template+##### Server Configuration TemplateThe recommended first-time flow is:@@ -339,7 +341,7 @@ If you prefer manual configuration, create `~/.openviking/ov.conf`, remove the c> **Note**: For embedding models, supported providers are `volcengine` (Doubao), `openai`, `azure`, `jina`, `ollama`, `voyage`, `dashscope`, `minimax`, `cohere`, `vikingdb`, `gemini` (requires `pip install "google-genai>=1.0.0"`), `litellm`, and `local`. For VLM models, common providers include `volcengine`, `openai`, `openai-codex`, `kimi`, and `glm`.-#### Server Configuration Examples+##### Server Configuration Examplesπ Expand to see the configuration example for your model service:@@ -478,7 +480,7 @@ Use `openviking-server init` and choose `OpenAI Codex`, then run `openviking-ser</details>-#### Set Server Configuration Environment Variable+##### Set Server Configuration Environment VariableAfter creating the configuration file, set the environment variable to point to it (Linux/macOS):@@ -502,7 +504,7 @@ set "OPENVIKING_CONFIG_FILE=%USERPROFILE%\.openviking\ov.conf"> π‘ **Tip**: You can also place the configuration file in other locations, just specify the correct path in the environment variable.-#### CLI/Client Configuration Examples+##### CLI/Client Configuration ExamplesYou can initialize the configuration of the CLI/client interactively through the `ov config` command. If you have multiple openviking servers, you can also switch to other configurations using the `ov config switch` command.@@ -539,13 +541,13 @@ set "OPENVIKING_CLI_CONFIG_FILE=%USERPROFILE%\.openviking\ovcli.conf"```</details>-### 4. Run Your First Example+#### 4. Run Your First Example> π **Prerequisite**: Ensure you have completed the configuration (ov.conf and ovcli.conf) in the previous step.Now let's run a complete example to experience the core features of OpenViking.-#### Launch Server+##### Launch Server```bashopenviking-server doctor@@ -560,7 +562,7 @@ or you can run in backgroundnohup openviking-server > /data/log/openviking.log 2>&1 &```-#### Run the CLI+##### Run the CLI```bashov status@@ -574,6 +576,10 @@ ov grep "openviking" --uri viking://resources/volcengine/OpenViking/docs/zhCongratulations! You have successfully run OpenViking π+### Commercial Access++OpenViking Personal is now officially available. Compared with the open-source edition, the Service version is officially hosted and ready to use, scales far beyond local hardware with VikingDB, and comes with richer integrations plus professional support. It includes a free trial for up to 50 files, and existing open-source users can move over smoothly with our migration tool.+### VikingBot Quick StartVikingBot is an AI agent framework built on top of OpenViking. Here's how to get started: