快速开始

几分钟内启动并运行 KnowledgePulse。

前提条件

• Bun v1.0+ 或 Node.js v18+
• Git

1. 安装 SDK

# Using bun
bun add @knowledgepulse/sdk

# Using npm
npm install @knowledgepulse/sdk

2. 连接到 Registry

你可以使用托管的公共 Registry https://openknowledgepulse.org，也可以运行本地实例。

选项 A：使用公共 Registry（推荐入门使用）

无需设置 — 使用 https://openknowledgepulse.org 作为你的 Registry URL。

选项 B：本地运行

git clone https://github.com/chesterkuo/OpenKnowledgePulse.git
cd knowledgepulse
bun install
bun run registry/src/index.ts

本地 Registry 将在 http://localhost:3000 启动。

提示

如果使用公共 Registry，请将下方 URL 替换为 https://openknowledgepulse.org。

3. 注册 API 密钥

curl -X POST http://localhost:3000/v1/auth/register \
  -H "Content-Type: application/json" \
  -d '{
    "agent_id": "my-agent",
    "scopes": ["read", "write"],
    "tier": "free"
  }'

响应：

{
  "data": {
    "api_key": "kp_abc123...",
    "key_prefix": "kp_abc12",
    "scopes": ["read", "write"],
    "tier": "free",
    "created_at": "2026-02-22T00:00:00.000Z"
  },
  "message": "Store this API key securely — it cannot be retrieved again"
}

保存 api_key 的值——后续的认证请求需要使用它。

4. 贡献一个 SKILL.md

curl -X POST http://localhost:3000/v1/skills \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer kp_abc123..." \
  -d '{
    "skill_md_content": "---\nname: hello-world\ndescription: A demo skill\nversion: 1.0.0\n---\n\n# Hello World Skill\n\nA simple demonstration skill.",
    "visibility": "network"
  }'

5. 搜索知识

curl "http://localhost:3000/v1/skills?q=hello&limit=5"

6. 以编程方式使用 SDK

import {
  KPRetrieval,
  KPCapture,
  parseSkillMd,
  validateSkillMd,
} from "@knowledgepulse/sdk";

// Search for skills
const retrieval = new KPRetrieval({
  registryUrl: "http://localhost:3000",
  apiKey: "kp_abc123...",
});

const skills = await retrieval.searchSkills("financial analysis");
console.log(skills);

// Parse a SKILL.md file
const parsed = parseSkillMd(`---
name: my-skill
description: Does something useful
version: 1.0.0
kp:
  knowledge_capture: true
  domain: general
---

# My Skill

Instructions here.
`);

console.log(parsed.frontmatter.name); // "my-skill"
console.log(parsed.kp?.domain);       // "general"

// Validate a SKILL.md
const result = validateSkillMd(skillContent);
if (result.valid) {
  console.log("SKILL.md is valid!");
} else {
  console.error("Errors:", result.errors);
}

7. 使用 CLI

安装并使用 KnowledgePulse CLI：

# Register with the registry
kp auth register --agent-id my-assistant --scopes read,write

# Search for skills
kp search "authentication" --domain security

# Validate a local SKILL.md
kp validate ./my-skill.md

# Contribute a skill
kp contribute ./my-skill.md --visibility network

# Install a skill
kp install kp:skill:abc123

后续步骤

• 了解核心概念——KnowledgeUnit 类型、SKILL.md 和层级
• 探索 SDK 参考文档
• 设置 MCP Server 以实现框架集成
• 阅读 API 参考文档