Skip to content

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

docs(sdk): document Go filesystem examples (#2687)

Qin Haojie8eb5553547a1
diff --git a/docs/en/api/03-filesystem.md b/docs/en/api/03-filesystem.md
index cce6170b1..446989ded 100644
--- a/docs/en/api/03-filesystem.md
+++ b/docs/en/api/03-filesystem.md
@@ -45,6 +45,16 @@ print(f"Abstract: {abstract}")
# Output: "Documentation for the project API, covering authentication, endpoints..."
```
+**Go SDK**
+
+```go
+abstract, err := client.Abstract(ctx, "viking://resources/docs/")
+if err != nil {
+ return err
+}
+fmt.Println(abstract)
+```
+
**HTTP API**
```
@@ -91,6 +101,16 @@ overview = client.overview("viking://resources/docs/")
print(f"Overview:\n{overview}")
```
+**Go SDK**
+
+```go
+overview, err := client.Overview(ctx, "viking://resources/docs/")
+if err != nil {
+ return err
+}
+fmt.Println(overview)
+```
+
**HTTP API**
```
@@ -145,6 +165,16 @@ content = client.read("viking://resources/docs/api.md")
print(f"Content:\n{content}")
```
+**Go SDK**
+
+```go
+content, err := client.Read(ctx, "viking://resources/docs/api.md", 0, -1)
+if err != nil {
+ return err
+}
+fmt.Println(content)
+```
+
**HTTP API**
```
@@ -208,6 +238,24 @@ result = client.write(
print(result["root_uri"])
```
+**Go SDK**
+
+```go
+result, err := client.Write(
+ ctx,
+ "viking://resources/docs/api.md",
+ "# Updated API\n\nFresh content.",
+ &openviking.WriteOptions{
+ Mode: "replace",
+ Wait: true,
+ },
+)
+if err != nil {
+ return err
+}
+fmt.Println(result["root_uri"])
+```
+
**HTTP API**
```
@@ -305,6 +353,18 @@ for entry in entries:
print(f"{entry['name']} - {type_str}")
```
+**Go SDK**
+
+```go
+entries, err := client.List(ctx, "viking://resources/", nil)
+if err != nil {
+ return err
+}
+for _, entry := range entries {
+ fmt.Println(entry)
+}
+```
+
**HTTP API**
```
@@ -376,6 +436,18 @@ for entry in entries:
print(f"{entry['rel_path']} - {type_str}")
```
+**Go SDK**
+
+```go
+entries, err := client.Tree(ctx, "viking://resources/", nil)
+if err != nil {
+ return err
+}
+for _, entry := range entries {
+ fmt.Println(entry["rel_path"], entry["isDir"])
+}
+```
+
**HTTP API**
```
@@ -443,6 +515,16 @@ if dir_info.get('isDir'):
print(f"Item count: {dir_info.get('count')}")
```
+**Go SDK**
+
+```go
+info, err := client.Stat(ctx, "viking://resources/docs/api.md")
+if err != nil {
+ return err
+}
+fmt.Println(info["size"], info["isDir"])
+```
+
**HTTP API**
```
@@ -522,6 +604,14 @@ client.mkdir("viking://resources/new-project/")
client.mkdir("viking://resources/new-project/", description="API docs directory")
```
+**Go SDK**
+
+```go
+if err := client.Mkdir(ctx, "viking://resources/new-project/", "API docs directory"); err != nil {
+ return err
+}
+```
+
**HTTP API**
```
@@ -585,6 +675,17 @@ if 'estimated_deleted_count' in result:
print(f"Deleted {result['estimated_deleted_count']} items")
```
+**Go SDK**
+
+```go
+err := client.Remove(ctx, "viking://resources/old-project/", &openviking.RemoveOptions{
+ Recursive: true,
+})
+if err != nil {
+ return err
+}
+```
+
**HTTP API**
```
@@ -658,6 +759,14 @@ client.mv(
)
```
+**Go SDK**
+
+```go
+if err := client.Move(ctx, "viking://resources/old-name/", "viking://resources/new-name/"); err != nil {
+ return err
+}
+```
+
**HTTP API**
```
@@ -725,6 +834,18 @@ for match in results['matches']:
print(f" {match['content']}")
```
+**Go SDK**
+
+```go
+result, err := client.Grep(ctx, "viking://resources/", "authentication", &openviking.GrepOptions{
+ CaseInsensitive: true,
+})
+if err != nil {
+ return err
+}
+fmt.Println(result["matches"])
+```
+
**HTTP API**
```
@@ -795,6 +916,16 @@ results = client.glob("**/*.py", "viking://resources/")
print(f"Found {results['count']} Python files")
```
+**Go SDK**
+
+```go
+result, err := client.Glob(ctx, "**/*.md", "viking://resources/")
+if err != nil {
+ return err
+}
+fmt.Println(result["matches"])
+```
+
**HTTP API**
```
@@ -1097,6 +1228,21 @@ client.initialize()
# Note: Export functionality is primarily used via CLI
```
+**Go SDK**
+
+```go
+outPath, err := client.ExportOVPack(
+ ctx,
+ "viking://resources/my-project/",
+ "./exports/my-project.ovpack",
+ &openviking.PackOptions{IncludeVectors: false},
+)
+if err != nil {
+ return err
+}
+fmt.Println(outPath)
+```
+
**CLI**
```bash
@@ -1203,6 +1349,24 @@ client.initialize()
# Note: Import functionality is primarily used via CLI
```
+**Go SDK**
+
+```go
+uri, err := client.ImportOVPack(
+ ctx,
+ "./exports/my-project.ovpack",
+ "viking://resources/imported/",
+ &openviking.ImportPackOptions{
+ OnConflict: "overwrite",
+ VectorMode: "auto",
+ },
+)
+if err != nil {
+ return err
+}
+fmt.Println(uri)
+```
+
**CLI**
```bash
@@ -1267,6 +1431,20 @@ curl -X POST http://localhost:1933/api/v1/pack/backup \
--output openviking-backup.ovpack
```
+Go SDK:
+
+```go
+outPath, err := client.BackupOVPack(
+ ctx,
+ "./backups/openviking.ovpack",
+ &openviking.PackOptions{IncludeVectors: true},
+)
+if err != nil {
+ return err
+}
+fmt.Println(outPath)
+```
+
CLI:
```bash
@@ -1308,6 +1486,23 @@ curl -X POST http://localhost:1933/api/v1/pack/restore \
-d "{\"temp_file_id\":\"$TEMP_FILE_ID\",\"on_conflict\":\"overwrite\",\"vector_mode\":\"auto\"}"
```
+Go SDK:
+
+```go
+uri, err := client.RestoreOVPack(
+ ctx,
+ "./backups/openviking.ovpack",
+ &openviking.ImportPackOptions{
+ OnConflict: "overwrite",
+ VectorMode: "require",
+ },
+)
+if err != nil {
+ return err
+}
+fmt.Println(uri)
+```
+
CLI:
```bash
diff --git a/docs/en/guides/09-ovpack.md b/docs/en/guides/09-ovpack.md
index 7dc45c85b..d0deb4b60 100644
--- a/docs/en/guides/09-ovpack.md
+++ b/docs/en/guides/09-ovpack.md
@@ -126,6 +126,16 @@ report = await client.check_consistency("viking://resources/my-project")
print(report["ok"], report["missing_records"])
```
+Go SDK:
+
+```go
+report, err := client.CheckConsistency(ctx, "viking://resources/my-project")
+if err != nil {
+ return err
+}
+fmt.Println(report["ok"], report["missing_records"])
+```
+
HTTP API:
```bash
@@ -186,6 +196,60 @@ await client.restore_ovpack(
)
```
+## Go SDK
+
+```go
+outPath, err := client.ExportOVPack(
+ ctx,
+ "viking://resources/my-project",
+ "./exports/my-project.ovpack",
+ &openviking.PackOptions{IncludeVectors: false},
+)
+if err != nil {
+ return err
+}
+
+importedURI, err := client.ImportOVPack(
+ ctx,
+ outPath,
+ "viking://resources/imported/",
+ &openviking.ImportPackOptions{
+ OnConflict: "overwrite",
+ VectorMode: "auto",
+ },
+)
+if err != nil {
+ return err
+}
+fmt.Println(importedURI)
+```
+
+Full backup:
+
+```go
+backupPath, err := client.BackupOVPack(
+ ctx,
+ "./backups/openviking.ovpack",
+ &openviking.PackOptions{IncludeVectors: true},
+)
+if err != nil {
+ return err
+}
+
+restoredURI, err := client.RestoreOVPack(
+ ctx,
+ backupPath,
+ &openviking.ImportPackOptions{
+ OnConflict: "overwrite",
+ VectorMode: "auto",
+ },
+)
+if err != nil {
+ return err
+}
+fmt.Println(restoredURI)
+```
+
## HTTP API
HTTP export returns a file stream directly. HTTP import and restore first upload
diff --git a/docs/zh/api/03-filesystem.md b/docs/zh/api/03-filesystem.md
index 67e801880..4e5509e0c 100644
--- a/docs/zh/api/03-filesystem.md
+++ b/docs/zh/api/03-filesystem.md
@@ -45,6 +45,16 @@ print(f"Abstract: {abstract}")
# Output: "Documentation for the project API, covering authentication, endpoints..."
```
+**Go SDK**
+
+```go
+abstract, err := client.Abstract(ctx, "viking://resources/docs/")
+if err != nil {
+ return err
+}
+fmt.Println(abstract)
+```
+
**HTTP API**
```
@@ -91,6 +101,16 @@ overview = client.overview("viking://resources/docs/")
print(f"Overview:\n{overview}")
```
+**Go SDK**
+
+```go
+overview, err := client.Overview(ctx, "viking://resources/docs/")
+if err != nil {
+ return err
+}
+fmt.Println(overview)
+```
+
**HTTP API**
```
@@ -145,6 +165,16 @@ content = client.read("viking://resources/docs/api.md")
print(f"Content:\n{content}")
```
+**Go SDK**
+
+```go
+content, err := client.Read(ctx, "viking://resources/docs/api.md", 0, -1)
+if err != nil {
+ return err
+}
+fmt.Println(content)
+```
+
**HTTP API**
```
@@ -208,6 +238,24 @@ result = client.write(
print(result["root_uri"])
```
+**Go SDK**
+
+```go
+result, err := client.Write(
+ ctx,
+ "viking://resources/docs/api.md",
+ "# Updated API\n\nFresh content.",
+ &openviking.WriteOptions{
+ Mode: "replace",
+ Wait: true,
+ },
+)
+if err != nil {
+ return err
+}
+fmt.Println(result["root_uri"])
+```
+
**HTTP API**
```
@@ -306,6 +354,18 @@ for entry in entries:
print(f"{entry['name']} - {type_str}")
```
+**Go SDK**
+
+```go
+entries, err := client.List(ctx, "viking://resources/", nil)
+if err != nil {
+ return err
+}
+for _, entry := range entries {
+ fmt.Println(entry)
+}
+```
+
**HTTP API**
```
@@ -377,6 +437,18 @@ for entry in entries:
print(f"{entry['rel_path']} - {type_str}")
```
+**Go SDK**
+
+```go
+entries, err := client.Tree(ctx, "viking://resources/", nil)
+if err != nil {
+ return err
+}
+for _, entry := range entries {
+ fmt.Println(entry["rel_path"], entry["isDir"])
+}
+```
+
**HTTP API**
```
@@ -444,6 +516,16 @@ if dir_info.get('isDir'):
print(f"Item count: {dir_info.get('count')}")
```
+**Go SDK**
+
+```go
+info, err := client.Stat(ctx, "viking://resources/docs/api.md")
+if err != nil {
+ return err
+}
+fmt.Println(info["size"], info["isDir"])
+```
+
**HTTP API**
```
@@ -523,6 +605,14 @@ client.mkdir("viking://resources/new-project/")
client.mkdir("viking://resources/new-project/", description="接口文档目录")
```
+**Go SDK**
+
+```go
+if err := client.Mkdir(ctx, "viking://resources/new-project/", "接口文档目录"); err != nil {
+ return err
+}
+```
+
**HTTP API**
```
@@ -586,6 +676,17 @@ if 'estimated_deleted_count' in result:
print(f"Deleted {result['estimated_deleted_count']} items")
```
+**Go SDK**
+
+```go
+err := client.Remove(ctx, "viking://resources/old-project/", &openviking.RemoveOptions{
+ Recursive: true,
+})
+if err != nil {
+ return err
+}
+```
+
**HTTP API**
```
@@ -659,6 +760,14 @@ client.mv(
)
```
+**Go SDK**
+
+```go
+if err := client.Move(ctx, "viking://resources/old-name/", "viking://resources/new-name/"); err != nil {
+ return err
+}
+```
+
**HTTP API**
```
@@ -726,6 +835,18 @@ for match in results['matches']:
print(f" {match['content']}")
```
+**Go SDK**
+
+```go
+result, err := client.Grep(ctx, "viking://resources/", "authentication", &openviking.GrepOptions{
+ CaseInsensitive: true,
+})
+if err != nil {
+ return err
+}
+fmt.Println(result["matches"])
+```
+
**HTTP API**
```
@@ -796,6 +917,16 @@ results = client.glob("**/*.py", "viking://resources/")
print(f"Found {results['count']} Python files")
```
+**Go SDK**
+
+```go
+result, err := client.Glob(ctx, "**/*.md", "viking://resources/")
+if err != nil {
+ return err
+}
+fmt.Println(result["matches"])
+```
+
**HTTP API**
```
@@ -1098,6 +1229,21 @@ client.initialize()
# 注意:导出功能主要通过 CLI 使用
```
+**Go SDK**
+
+```go
+outPath, err := client.ExportOVPack(
+ ctx,
+ "viking://resources/my-project/",
+ "./exports/my-project.ovpack",
+ &openviking.PackOptions{IncludeVectors: false},
+)
+if err != nil {
+ return err
+}
+fmt.Println(outPath)
+```
+
**CLI**
```bash
@@ -1204,6 +1350,24 @@ client.initialize()
# 注意:导入功能主要通过 CLI 使用
```
+**Go SDK**
+
+```go
+uri, err := client.ImportOVPack(
+ ctx,
+ "./exports/my-project.ovpack",
+ "viking://resources/imported/",
+ &openviking.ImportPackOptions{
+ OnConflict: "overwrite",
+ VectorMode: "auto",
+ },
+)
+if err != nil {
+ return err
+}
+fmt.Println(uri)
+```
+
**CLI**
```bash
@@ -1267,6 +1431,20 @@ curl -X POST http://localhost:1933/api/v1/pack/backup \
--output openviking-backup.ovpack
```
+Go SDK:
+
+```go
+outPath, err := client.BackupOVPack(
+ ctx,
+ "./backups/openviking.ovpack",
+ &openviking.PackOptions{IncludeVectors: true},
+)
+if err != nil {
+ return err
+}
+fmt.Println(outPath)
+```
+
CLI:
```bash
@@ -1306,6 +1484,23 @@ curl -X POST http://localhost:1933/api/v1/pack/restore \
-d "{\"temp_file_id\":\"$TEMP_FILE_ID\",\"on_conflict\":\"overwrite\",\"vector_mode\":\"auto\"}"
```
+Go SDK:
+
+```go
+uri, err := client.RestoreOVPack(
+ ctx,
+ "./backups/openviking.ovpack",
+ &openviking.ImportPackOptions{
+ OnConflict: "overwrite",
+ VectorMode: "require",
+ },
+)
+if err != nil {
+ return err
+}
+fmt.Println(uri)
+```
+
CLI:
```bash
diff --git a/docs/zh/guides/09-ovpack.md b/docs/zh/guides/09-ovpack.md
index d1a7d9f45..d26837702 100644
--- a/docs/zh/guides/09-ovpack.md
+++ b/docs/zh/guides/09-ovpack.md
@@ -108,6 +108,16 @@ report = await client.check_consistency("viking://resources/my-project")
print(report["ok"], report["missing_records"])
```
+Go SDK:
+
+```go
+report, err := client.CheckConsistency(ctx, "viking://resources/my-project")
+if err != nil {
+ return err
+}
+fmt.Println(report["ok"], report["missing_records"])
+```
+
HTTP API:
```bash
@@ -167,6 +177,60 @@ await client.restore_ovpack(
)
```
+## Go SDK
+
+```go
+outPath, err := client.ExportOVPack(
+ ctx,
+ "viking://resources/my-project",
+ "./exports/my-project.ovpack",
+ &openviking.PackOptions{IncludeVectors: false},
+)
+if err != nil {
+ return err
+}
+
+importedURI, err := client.ImportOVPack(
+ ctx,
+ outPath,
+ "viking://resources/imported/",
+ &openviking.ImportPackOptions{
+ OnConflict: "overwrite",
+ VectorMode: "auto",
+ },
+)
+if err != nil {
+ return err
+}
+fmt.Println(importedURI)
+```
+
+全量备份:
+
+```go
+backupPath, err := client.BackupOVPack(
+ ctx,
+ "./backups/openviking.ovpack",
+ &openviking.PackOptions{IncludeVectors: true},
+)
+if err != nil {
+ return err
+}
+
+restoredURI, err := client.RestoreOVPack(
+ ctx,
+ backupPath,
+ &openviking.ImportPackOptions{
+ OnConflict: "overwrite",
+ VectorMode: "auto",
+ },
+)
+if err != nil {
+ return err
+}
+fmt.Println(restoredURI)
+```
+
## HTTP API
HTTP 导出接口直接返回文件流;HTTP 导入和恢复必须先上传本地 `.ovpack`,再用