opc-agent 1.1.1 → 1.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (139) hide show
  1. package/CHANGELOG.md +51 -51
  2. package/CONTRIBUTING.md +75 -75
  3. package/README.md +222 -126
  4. package/README.zh-CN.md +129 -80
  5. package/dist/channels/web.js +256 -256
  6. package/dist/deploy/hermes.js +22 -22
  7. package/dist/deploy/openclaw.js +31 -31
  8. package/dist/templates/code-reviewer.js +5 -5
  9. package/dist/templates/customer-service.js +2 -2
  10. package/dist/templates/data-analyst.js +5 -5
  11. package/dist/templates/knowledge-base.js +2 -2
  12. package/dist/templates/sales-assistant.js +4 -4
  13. package/dist/templates/teacher.js +6 -6
  14. package/docs/.vitepress/config.ts +103 -103
  15. package/docs/api/cli.md +48 -48
  16. package/docs/api/oad-schema.md +64 -64
  17. package/docs/api/sdk.md +80 -80
  18. package/docs/guide/concepts.md +51 -51
  19. package/docs/guide/configuration.md +79 -79
  20. package/docs/guide/deployment.md +42 -42
  21. package/docs/guide/getting-started.md +44 -44
  22. package/docs/guide/templates.md +28 -28
  23. package/docs/guide/testing.md +84 -84
  24. package/docs/index.md +27 -27
  25. package/docs/zh/api/cli.md +54 -54
  26. package/docs/zh/api/oad-schema.md +87 -87
  27. package/docs/zh/api/sdk.md +102 -102
  28. package/docs/zh/guide/concepts.md +104 -104
  29. package/docs/zh/guide/configuration.md +135 -135
  30. package/docs/zh/guide/deployment.md +81 -81
  31. package/docs/zh/guide/getting-started.md +82 -82
  32. package/docs/zh/guide/templates.md +84 -84
  33. package/docs/zh/guide/testing.md +88 -88
  34. package/docs/zh/index.md +27 -27
  35. package/examples/customer-service-demo/README.md +90 -90
  36. package/examples/customer-service-demo/oad.yaml +107 -107
  37. package/package.json +1 -1
  38. package/src/analytics/index.ts +66 -66
  39. package/src/channels/discord.ts +192 -192
  40. package/src/channels/email.ts +177 -177
  41. package/src/channels/feishu.ts +236 -236
  42. package/src/channels/index.ts +15 -15
  43. package/src/channels/slack.ts +160 -160
  44. package/src/channels/telegram.ts +90 -90
  45. package/src/channels/voice.ts +106 -106
  46. package/src/channels/web.ts +596 -596
  47. package/src/channels/webhook.ts +199 -199
  48. package/src/channels/websocket.ts +87 -87
  49. package/src/channels/wechat.ts +149 -149
  50. package/src/core/a2a.ts +143 -143
  51. package/src/core/agent.ts +152 -152
  52. package/src/core/analytics-engine.ts +186 -186
  53. package/src/core/auth.ts +57 -57
  54. package/src/core/cache.ts +141 -141
  55. package/src/core/compose.ts +77 -77
  56. package/src/core/config.ts +14 -14
  57. package/src/core/errors.ts +148 -148
  58. package/src/core/hitl.ts +138 -138
  59. package/src/core/knowledge.ts +210 -210
  60. package/src/core/logger.ts +57 -57
  61. package/src/core/orchestrator.ts +215 -215
  62. package/src/core/performance.ts +187 -187
  63. package/src/core/rate-limiter.ts +128 -128
  64. package/src/core/room.ts +109 -109
  65. package/src/core/runtime.ts +152 -152
  66. package/src/core/sandbox.ts +101 -101
  67. package/src/core/security.ts +171 -171
  68. package/src/core/types.ts +68 -68
  69. package/src/core/versioning.ts +106 -106
  70. package/src/core/watch.ts +178 -178
  71. package/src/core/workflow.ts +235 -235
  72. package/src/deploy/hermes.ts +156 -156
  73. package/src/deploy/openclaw.ts +200 -200
  74. package/src/dtv/data.ts +29 -29
  75. package/src/dtv/trust.ts +43 -43
  76. package/src/dtv/value.ts +47 -47
  77. package/src/i18n/index.ts +216 -216
  78. package/src/index.ts +110 -110
  79. package/src/marketplace/index.ts +223 -223
  80. package/src/memory/deepbrain.ts +108 -108
  81. package/src/memory/index.ts +34 -34
  82. package/src/plugins/index.ts +208 -208
  83. package/src/providers/index.ts +183 -183
  84. package/src/schema/oad.ts +155 -155
  85. package/src/skills/base.ts +16 -16
  86. package/src/skills/document.ts +100 -100
  87. package/src/skills/http.ts +35 -35
  88. package/src/skills/index.ts +27 -27
  89. package/src/skills/scheduler.ts +80 -80
  90. package/src/skills/webhook-trigger.ts +59 -59
  91. package/src/templates/code-reviewer.ts +34 -34
  92. package/src/templates/customer-service.ts +80 -80
  93. package/src/templates/data-analyst.ts +70 -70
  94. package/src/templates/executive-assistant.ts +71 -71
  95. package/src/templates/financial-advisor.ts +60 -60
  96. package/src/templates/knowledge-base.ts +31 -31
  97. package/src/templates/legal-assistant.ts +71 -71
  98. package/src/templates/sales-assistant.ts +79 -79
  99. package/src/templates/teacher.ts +79 -79
  100. package/src/testing/index.ts +181 -181
  101. package/src/tools/calculator.ts +73 -73
  102. package/src/tools/datetime.ts +149 -149
  103. package/src/tools/json-transform.ts +187 -187
  104. package/src/tools/mcp.ts +76 -76
  105. package/src/tools/text-analysis.ts +116 -116
  106. package/templates/Dockerfile +15 -15
  107. package/templates/code-reviewer/README.md +27 -27
  108. package/templates/code-reviewer/oad.yaml +41 -41
  109. package/templates/customer-service/README.md +22 -22
  110. package/templates/customer-service/oad.yaml +36 -36
  111. package/templates/docker-compose.yml +21 -21
  112. package/templates/knowledge-base/README.md +28 -28
  113. package/templates/knowledge-base/oad.yaml +38 -38
  114. package/templates/sales-assistant/README.md +26 -26
  115. package/templates/sales-assistant/oad.yaml +43 -43
  116. package/tests/a2a.test.ts +66 -66
  117. package/tests/agent.test.ts +72 -72
  118. package/tests/analytics.test.ts +50 -50
  119. package/tests/channel.test.ts +39 -39
  120. package/tests/e2e.test.ts +134 -134
  121. package/tests/errors.test.ts +83 -83
  122. package/tests/hitl.test.ts +71 -71
  123. package/tests/i18n.test.ts +41 -41
  124. package/tests/mcp.test.ts +54 -54
  125. package/tests/oad.test.ts +68 -68
  126. package/tests/performance.test.ts +115 -115
  127. package/tests/plugin.test.ts +74 -74
  128. package/tests/room.test.ts +106 -106
  129. package/tests/runtime.test.ts +42 -42
  130. package/tests/sandbox.test.ts +46 -46
  131. package/tests/security.test.ts +60 -60
  132. package/tests/templates.test.ts +77 -77
  133. package/tests/v070.test.ts +76 -76
  134. package/tests/versioning.test.ts +75 -75
  135. package/tests/voice.test.ts +61 -61
  136. package/tests/webhook.test.ts +29 -29
  137. package/tests/workflow.test.ts +143 -143
  138. package/tsconfig.json +19 -19
  139. package/vitest.config.ts +9 -9
@@ -41,27 +41,27 @@ const fs = __importStar(require("fs"));
41
41
  const path = __importStar(require("path"));
42
42
  function generateIdentityMd(oad) {
43
43
  const m = oad.metadata;
44
- return `# IDENTITY.md
45
-
46
- - **Name:** ${m.name}
47
- - **Version:** ${m.version}
48
- - **Description:** ${m.description ?? 'An AI agent'}
49
- - **Author:** ${m.author ?? 'Unknown'}
50
- - **License:** ${m.license}
44
+ return `# IDENTITY.md
45
+
46
+ - **Name:** ${m.name}
47
+ - **Version:** ${m.version}
48
+ - **Description:** ${m.description ?? 'An AI agent'}
49
+ - **Author:** ${m.author ?? 'Unknown'}
50
+ - **License:** ${m.license}
51
51
  `;
52
52
  }
53
53
  function generateSoulMd(oad) {
54
54
  const prompt = oad.spec.systemPrompt ?? 'You are a helpful AI assistant.';
55
- return `# SOUL.md - ${oad.metadata.name}
56
-
57
- ## System Prompt
58
-
59
- ${prompt}
60
-
61
- ## Model Configuration
62
-
63
- - **Model:** ${oad.spec.model}
64
- - **Provider:** ${oad.spec.provider?.default ?? 'deepseek'}
55
+ return `# SOUL.md - ${oad.metadata.name}
56
+
57
+ ## System Prompt
58
+
59
+ ${prompt}
60
+
61
+ ## Model Configuration
62
+
63
+ - **Model:** ${oad.spec.model}
64
+ - **Provider:** ${oad.spec.provider?.default ?? 'deepseek'}
65
65
  `;
66
66
  }
67
67
  function generateAgentsMd(oad) {
@@ -112,23 +112,23 @@ function generateAgentsMd(oad) {
112
112
  return md;
113
113
  }
114
114
  function generateUserMd(oad) {
115
- return `# USER.md
116
-
117
- - **Name:** (your name)
118
- - **Role:** User
119
- - **Notes:** Configure this file with your preferences for ${oad.metadata.name}.
115
+ return `# USER.md
116
+
117
+ - **Name:** (your name)
118
+ - **Role:** User
119
+ - **Notes:** Configure this file with your preferences for ${oad.metadata.name}.
120
120
  `;
121
121
  }
122
122
  function generateMemoryMd(oad) {
123
- return `# MEMORY.md - ${oad.metadata.name}
124
-
125
- ## Persistent Knowledge
126
-
127
- (Agent will store learned information here)
128
-
129
- ## User Preferences
130
-
131
- (Discovered user preferences will be noted here)
123
+ return `# MEMORY.md - ${oad.metadata.name}
124
+
125
+ ## Persistent Knowledge
126
+
127
+ (Agent will store learned information here)
128
+
129
+ ## User Preferences
130
+
131
+ (Discovered user preferences will be noted here)
132
132
  `;
133
133
  }
134
134
  function generateOpenClawConfig(oad, agentDir) {
@@ -2,11 +2,11 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.CODE_REVIEWER_SYSTEM_PROMPT = void 0;
4
4
  exports.createCodeReviewerConfig = createCodeReviewerConfig;
5
- exports.CODE_REVIEWER_SYSTEM_PROMPT = `You are an expert code reviewer. When given code:
6
- 1. Check for bugs, security issues, and performance problems
7
- 2. Suggest improvements for readability and maintainability
8
- 3. Follow language-specific best practices
9
- 4. Be constructive and explain your reasoning
5
+ exports.CODE_REVIEWER_SYSTEM_PROMPT = `You are an expert code reviewer. When given code:
6
+ 1. Check for bugs, security issues, and performance problems
7
+ 2. Suggest improvements for readability and maintainability
8
+ 3. Follow language-specific best practices
9
+ 4. Be constructive and explain your reasoning
10
10
  Rate severity: 🔴 Critical | 🟡 Warning | 🔵 Info`;
11
11
  function createCodeReviewerConfig() {
12
12
  return {
@@ -41,8 +41,8 @@ class HandoffSkill extends base_1.BaseSkill {
41
41
  }
42
42
  }
43
43
  exports.HandoffSkill = HandoffSkill;
44
- exports.CUSTOMER_SERVICE_SYSTEM_PROMPT = `You are a friendly and professional customer service agent.
45
- You help customers with their questions about products, orders, shipping, and returns.
44
+ exports.CUSTOMER_SERVICE_SYSTEM_PROMPT = `You are a friendly and professional customer service agent.
45
+ You help customers with their questions about products, orders, shipping, and returns.
46
46
  Be concise, helpful, and empathetic. If you're unsure, offer to connect them with a human agent.`;
47
47
  function createCustomerServiceConfig() {
48
48
  return {
@@ -33,11 +33,11 @@ class InsightSkill extends base_1.BaseSkill {
33
33
  }
34
34
  }
35
35
  exports.InsightSkill = InsightSkill;
36
- exports.DATA_ANALYST_SYSTEM_PROMPT = `You are a professional data analyst assistant. Your goals:
37
- 1. Help users query, transform, and analyze data
38
- 2. Create clear visualizations and summaries
39
- 3. Identify trends, patterns, and anomalies
40
- 4. Explain findings in plain language
36
+ exports.DATA_ANALYST_SYSTEM_PROMPT = `You are a professional data analyst assistant. Your goals:
37
+ 1. Help users query, transform, and analyze data
38
+ 2. Create clear visualizations and summaries
39
+ 3. Identify trends, patterns, and anomalies
40
+ 4. Explain findings in plain language
41
41
  Be precise with numbers, always cite your data source, and suggest next steps for deeper analysis.`;
42
42
  function createDataAnalystConfig() {
43
43
  return {
@@ -2,8 +2,8 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.KNOWLEDGE_BASE_SYSTEM_PROMPT = void 0;
4
4
  exports.createKnowledgeBaseConfig = createKnowledgeBaseConfig;
5
- exports.KNOWLEDGE_BASE_SYSTEM_PROMPT = `You are a knowledge base assistant. Answer questions using the company documents
6
- and knowledge provided to you. If you don't have enough information, say so honestly.
5
+ exports.KNOWLEDGE_BASE_SYSTEM_PROMPT = `You are a knowledge base assistant. Answer questions using the company documents
6
+ and knowledge provided to you. If you don't have enough information, say so honestly.
7
7
  Always cite sources when possible. Be accurate and concise.`;
8
8
  function createKnowledgeBaseConfig() {
9
9
  return {
@@ -43,10 +43,10 @@ class LeadCaptureSkill extends base_1.BaseSkill {
43
43
  }
44
44
  }
45
45
  exports.LeadCaptureSkill = LeadCaptureSkill;
46
- exports.SALES_ASSISTANT_SYSTEM_PROMPT = `You are a professional sales assistant. Your goals:
47
- 1. Answer product questions accurately and enthusiastically
48
- 2. Capture leads by collecting name, email, and company info
49
- 3. Book appointments when prospects are ready
46
+ exports.SALES_ASSISTANT_SYSTEM_PROMPT = `You are a professional sales assistant. Your goals:
47
+ 1. Answer product questions accurately and enthusiastically
48
+ 2. Capture leads by collecting name, email, and company info
49
+ 3. Book appointments when prospects are ready
50
50
  Be friendly, persuasive but not pushy. Always provide value first.`;
51
51
  function createSalesAssistantConfig() {
52
52
  return {
@@ -39,12 +39,12 @@ class ExplainSkill extends base_1.BaseSkill {
39
39
  }
40
40
  }
41
41
  exports.ExplainSkill = ExplainSkill;
42
- exports.TEACHER_SYSTEM_PROMPT = `You are a patient and encouraging teacher assistant. Your goals:
43
- 1. Create engaging lesson plans tailored to student level
44
- 2. Generate quizzes and assessments with answer keys
45
- 3. Explain complex concepts using analogies and examples
46
- 4. Provide constructive feedback and encouragement
47
- 5. Adapt teaching style to different learning preferences
42
+ exports.TEACHER_SYSTEM_PROMPT = `You are a patient and encouraging teacher assistant. Your goals:
43
+ 1. Create engaging lesson plans tailored to student level
44
+ 2. Generate quizzes and assessments with answer keys
45
+ 3. Explain complex concepts using analogies and examples
46
+ 4. Provide constructive feedback and encouragement
47
+ 5. Adapt teaching style to different learning preferences
48
48
  Be patient, use clear language, and always check for understanding. Use the Socratic method when appropriate.`;
49
49
  function createTeacherConfig() {
50
50
  return {
@@ -1,103 +1,103 @@
1
- import { defineConfig } from 'vitepress';
2
-
3
- export default defineConfig({
4
- title: 'OPC Agent',
5
- description: 'Open Agent Framework - Build, test, and run AI Agents for business workstations',
6
-
7
- locales: {
8
- root: {
9
- label: 'English',
10
- lang: 'en',
11
- themeConfig: {
12
- nav: [
13
- { text: 'Guide', link: '/guide/getting-started' },
14
- { text: 'API', link: '/api/oad-schema' },
15
- { text: 'GitHub', link: 'https://github.com/Deepleaper/opc-agent' },
16
- ],
17
- sidebar: {
18
- '/guide/': [
19
- {
20
- text: 'Introduction',
21
- items: [
22
- { text: 'Getting Started', link: '/guide/getting-started' },
23
- { text: 'Core Concepts', link: '/guide/concepts' },
24
- ],
25
- },
26
- {
27
- text: 'Usage',
28
- items: [
29
- { text: 'Templates', link: '/guide/templates' },
30
- { text: 'Configuration', link: '/guide/configuration' },
31
- { text: 'Testing', link: '/guide/testing' },
32
- { text: 'Deployment', link: '/guide/deployment' },
33
- ],
34
- },
35
- ],
36
- '/api/': [
37
- {
38
- text: 'Reference',
39
- items: [
40
- { text: 'OAD Schema', link: '/api/oad-schema' },
41
- { text: 'CLI Commands', link: '/api/cli' },
42
- { text: 'SDK', link: '/api/sdk' },
43
- ],
44
- },
45
- ],
46
- },
47
- },
48
- },
49
- zh: {
50
- label: '中文',
51
- lang: 'zh-CN',
52
- description: '开放智能体框架 — 构建、测试、运行企业级 AI 智能体',
53
- themeConfig: {
54
- nav: [
55
- { text: '指南', link: '/zh/guide/getting-started' },
56
- { text: 'API', link: '/zh/api/oad-schema' },
57
- { text: 'GitHub', link: 'https://github.com/Deepleaper/opc-agent' },
58
- ],
59
- sidebar: {
60
- '/zh/guide/': [
61
- {
62
- text: '入门',
63
- items: [
64
- { text: '快速开始', link: '/zh/guide/getting-started' },
65
- { text: '核心概念', link: '/zh/guide/concepts' },
66
- ],
67
- },
68
- {
69
- text: '使用',
70
- items: [
71
- { text: '模板', link: '/zh/guide/templates' },
72
- { text: '配置', link: '/zh/guide/configuration' },
73
- { text: '测试', link: '/zh/guide/testing' },
74
- { text: '部署', link: '/zh/guide/deployment' },
75
- ],
76
- },
77
- ],
78
- '/zh/api/': [
79
- {
80
- text: '参考',
81
- items: [
82
- { text: 'OAD Schema', link: '/zh/api/oad-schema' },
83
- { text: 'CLI 命令', link: '/zh/api/cli' },
84
- { text: 'SDK', link: '/zh/api/sdk' },
85
- ],
86
- },
87
- ],
88
- },
89
- },
90
- },
91
- },
92
-
93
- themeConfig: {
94
- logo: '/logo.svg',
95
- socialLinks: [
96
- { icon: 'github', link: 'https://github.com/Deepleaper/opc-agent' },
97
- ],
98
- footer: {
99
- message: 'Released under the Apache-2.0 License.',
100
- copyright: 'Copyright © 2025 Deepleaper 跃盟科技',
101
- },
102
- },
103
- });
1
+ import { defineConfig } from 'vitepress';
2
+
3
+ export default defineConfig({
4
+ title: 'OPC Agent',
5
+ description: 'Open Agent Framework - Build, test, and run AI Agents for business workstations',
6
+
7
+ locales: {
8
+ root: {
9
+ label: 'English',
10
+ lang: 'en',
11
+ themeConfig: {
12
+ nav: [
13
+ { text: 'Guide', link: '/guide/getting-started' },
14
+ { text: 'API', link: '/api/oad-schema' },
15
+ { text: 'GitHub', link: 'https://github.com/Deepleaper/opc-agent' },
16
+ ],
17
+ sidebar: {
18
+ '/guide/': [
19
+ {
20
+ text: 'Introduction',
21
+ items: [
22
+ { text: 'Getting Started', link: '/guide/getting-started' },
23
+ { text: 'Core Concepts', link: '/guide/concepts' },
24
+ ],
25
+ },
26
+ {
27
+ text: 'Usage',
28
+ items: [
29
+ { text: 'Templates', link: '/guide/templates' },
30
+ { text: 'Configuration', link: '/guide/configuration' },
31
+ { text: 'Testing', link: '/guide/testing' },
32
+ { text: 'Deployment', link: '/guide/deployment' },
33
+ ],
34
+ },
35
+ ],
36
+ '/api/': [
37
+ {
38
+ text: 'Reference',
39
+ items: [
40
+ { text: 'OAD Schema', link: '/api/oad-schema' },
41
+ { text: 'CLI Commands', link: '/api/cli' },
42
+ { text: 'SDK', link: '/api/sdk' },
43
+ ],
44
+ },
45
+ ],
46
+ },
47
+ },
48
+ },
49
+ zh: {
50
+ label: '中文',
51
+ lang: 'zh-CN',
52
+ description: '开放智能体框架 — 构建、测试、运行企业级 AI 智能体',
53
+ themeConfig: {
54
+ nav: [
55
+ { text: '指南', link: '/zh/guide/getting-started' },
56
+ { text: 'API', link: '/zh/api/oad-schema' },
57
+ { text: 'GitHub', link: 'https://github.com/Deepleaper/opc-agent' },
58
+ ],
59
+ sidebar: {
60
+ '/zh/guide/': [
61
+ {
62
+ text: '入门',
63
+ items: [
64
+ { text: '快速开始', link: '/zh/guide/getting-started' },
65
+ { text: '核心概念', link: '/zh/guide/concepts' },
66
+ ],
67
+ },
68
+ {
69
+ text: '使用',
70
+ items: [
71
+ { text: '模板', link: '/zh/guide/templates' },
72
+ { text: '配置', link: '/zh/guide/configuration' },
73
+ { text: '测试', link: '/zh/guide/testing' },
74
+ { text: '部署', link: '/zh/guide/deployment' },
75
+ ],
76
+ },
77
+ ],
78
+ '/zh/api/': [
79
+ {
80
+ text: '参考',
81
+ items: [
82
+ { text: 'OAD Schema', link: '/zh/api/oad-schema' },
83
+ { text: 'CLI 命令', link: '/zh/api/cli' },
84
+ { text: 'SDK', link: '/zh/api/sdk' },
85
+ ],
86
+ },
87
+ ],
88
+ },
89
+ },
90
+ },
91
+ },
92
+
93
+ themeConfig: {
94
+ logo: '/logo.svg',
95
+ socialLinks: [
96
+ { icon: 'github', link: 'https://github.com/Deepleaper/opc-agent' },
97
+ ],
98
+ footer: {
99
+ message: 'Released under the Apache-2.0 License.',
100
+ copyright: 'Copyright © 2025 Deepleaper 跃盟科技',
101
+ },
102
+ },
103
+ });
package/docs/api/cli.md CHANGED
@@ -1,48 +1,48 @@
1
- # CLI Commands
2
-
3
- ## Reference
4
-
5
- | Command | Description |
6
- |---------|-------------|
7
- | `opc init [name]` | Initialize a new agent project |
8
- | `opc run` | Start agent with web server |
9
- | `opc chat` | Interactive CLI chat |
10
- | `opc test` | Run agent tests |
11
- | `opc analytics` | Show usage analytics |
12
- | `opc info` | Show agent info from OAD |
13
- | `opc build` | Validate OAD |
14
- | `opc dev` | Hot-reload development mode |
15
- | `opc create <name>` | Create agent from template |
16
- | `opc deploy` | Deploy to OpenClaw or Hermes |
17
- | `opc publish` | Package for distribution |
18
- | `opc install <source>` | Install agent from package |
19
- | `opc search <query>` | Search OPC Registry |
20
- | `opc stats` | Show runtime stats |
21
- | `opc kb add <file>` | Add file to knowledge base |
22
- | `opc kb search <query>` | Search knowledge base |
23
- | `opc tool list` | List MCP tools |
24
- | `opc workflow run <name>` | Run a workflow |
25
- | `opc version-mgmt list` | List saved versions |
26
-
27
- ## Common Options
28
-
29
- - `-f, --file <file>` — OAD file path (default: `oad.yaml`)
30
- - `-t, --template <name>` — Template name
31
- - `-p, --port <port>` — Port override
32
- - `--json` — JSON output (for test/analytics)
33
-
34
- ## Examples
35
-
36
- ```bash
37
- # Create a new project
38
- opc init my-bot -t teacher
39
-
40
- # Run tests
41
- opc test --json
42
-
43
- # View analytics
44
- opc analytics
45
-
46
- # Deploy
47
- opc deploy --target openclaw --install
48
- ```
1
+ # CLI Commands
2
+
3
+ ## Reference
4
+
5
+ | Command | Description |
6
+ |---------|-------------|
7
+ | `opc init [name]` | Initialize a new agent project |
8
+ | `opc run` | Start agent with web server |
9
+ | `opc chat` | Interactive CLI chat |
10
+ | `opc test` | Run agent tests |
11
+ | `opc analytics` | Show usage analytics |
12
+ | `opc info` | Show agent info from OAD |
13
+ | `opc build` | Validate OAD |
14
+ | `opc dev` | Hot-reload development mode |
15
+ | `opc create <name>` | Create agent from template |
16
+ | `opc deploy` | Deploy to OpenClaw or Hermes |
17
+ | `opc publish` | Package for distribution |
18
+ | `opc install <source>` | Install agent from package |
19
+ | `opc search <query>` | Search OPC Registry |
20
+ | `opc stats` | Show runtime stats |
21
+ | `opc kb add <file>` | Add file to knowledge base |
22
+ | `opc kb search <query>` | Search knowledge base |
23
+ | `opc tool list` | List MCP tools |
24
+ | `opc workflow run <name>` | Run a workflow |
25
+ | `opc version-mgmt list` | List saved versions |
26
+
27
+ ## Common Options
28
+
29
+ - `-f, --file <file>` — OAD file path (default: `oad.yaml`)
30
+ - `-t, --template <name>` — Template name
31
+ - `-p, --port <port>` — Port override
32
+ - `--json` — JSON output (for test/analytics)
33
+
34
+ ## Examples
35
+
36
+ ```bash
37
+ # Create a new project
38
+ opc init my-bot -t teacher
39
+
40
+ # Run tests
41
+ opc test --json
42
+
43
+ # View analytics
44
+ opc analytics
45
+
46
+ # Deploy
47
+ opc deploy --target openclaw --install
48
+ ```
@@ -1,64 +1,64 @@
1
- # OAD Schema v1 Specification
2
-
3
- **OAD** (Open Agent Definition) is a declarative YAML/JSON format for defining AI agents.
4
-
5
- ## Full Schema
6
-
7
- ```yaml
8
- apiVersion: opc/v1 # Required. Must be "opc/v1"
9
- kind: Agent # Required. Must be "Agent"
10
-
11
- metadata:
12
- name: string # Required. Agent identifier
13
- version: string # Semver. Default: "1.0.0"
14
- description: string # Optional. Human-readable description
15
- author: string # Optional. Author name
16
- license: string # Default: "Apache-2.0"
17
- marketplace: # Optional. Marketplace settings
18
- certified: boolean # Default: false
19
- category: string # e.g., "customer-service"
20
-
21
- spec:
22
- provider: # LLM provider configuration
23
- default: string # Default provider. Default: "deepseek"
24
- allowed: string[] # Allowed providers. Default: ["openai", "deepseek", "qwen"]
25
- model: string # Model name. Default: "deepseek-chat"
26
- systemPrompt: string # System prompt for the agent
27
-
28
- skills: # List of skills
29
- - name: string # Skill identifier
30
- description: string # What the skill does
31
- config: object # Optional skill-specific config
32
-
33
- channels: # Communication channels
34
- - type: web|websocket|cli
35
- port: number # Port for web channels
36
- config: object # Optional channel config
37
-
38
- memory:
39
- shortTerm: boolean # Enable conversation memory. Default: true
40
- longTerm: boolean # Enable persistent memory. Default: false
41
- provider: string # Memory backend (optional)
42
-
43
- dtv:
44
- trust:
45
- level: sandbox|verified|certified|listed # Default: "sandbox"
46
- value:
47
- metrics: string[] # Metrics to track. Default: []
48
- ```
49
-
50
- ## Validation
51
-
52
- OAD files are validated using Zod schemas. Use the CLI to validate:
53
-
54
- ```bash
55
- opc build -f oad.yaml
56
- ```
57
-
58
- Or programmatically:
59
-
60
- ```typescript
61
- import { validateOAD } from 'opc-agent';
62
-
63
- const config = validateOAD(yamlData);
64
- ```
1
+ # OAD Schema v1 Specification
2
+
3
+ **OAD** (Open Agent Definition) is a declarative YAML/JSON format for defining AI agents.
4
+
5
+ ## Full Schema
6
+
7
+ ```yaml
8
+ apiVersion: opc/v1 # Required. Must be "opc/v1"
9
+ kind: Agent # Required. Must be "Agent"
10
+
11
+ metadata:
12
+ name: string # Required. Agent identifier
13
+ version: string # Semver. Default: "1.0.0"
14
+ description: string # Optional. Human-readable description
15
+ author: string # Optional. Author name
16
+ license: string # Default: "Apache-2.0"
17
+ marketplace: # Optional. Marketplace settings
18
+ certified: boolean # Default: false
19
+ category: string # e.g., "customer-service"
20
+
21
+ spec:
22
+ provider: # LLM provider configuration
23
+ default: string # Default provider. Default: "deepseek"
24
+ allowed: string[] # Allowed providers. Default: ["openai", "deepseek", "qwen"]
25
+ model: string # Model name. Default: "deepseek-chat"
26
+ systemPrompt: string # System prompt for the agent
27
+
28
+ skills: # List of skills
29
+ - name: string # Skill identifier
30
+ description: string # What the skill does
31
+ config: object # Optional skill-specific config
32
+
33
+ channels: # Communication channels
34
+ - type: web|websocket|cli
35
+ port: number # Port for web channels
36
+ config: object # Optional channel config
37
+
38
+ memory:
39
+ shortTerm: boolean # Enable conversation memory. Default: true
40
+ longTerm: boolean # Enable persistent memory. Default: false
41
+ provider: string # Memory backend (optional)
42
+
43
+ dtv:
44
+ trust:
45
+ level: sandbox|verified|certified|listed # Default: "sandbox"
46
+ value:
47
+ metrics: string[] # Metrics to track. Default: []
48
+ ```
49
+
50
+ ## Validation
51
+
52
+ OAD files are validated using Zod schemas. Use the CLI to validate:
53
+
54
+ ```bash
55
+ opc build -f oad.yaml
56
+ ```
57
+
58
+ Or programmatically:
59
+
60
+ ```typescript
61
+ import { validateOAD } from 'opc-agent';
62
+
63
+ const config = validateOAD(yamlData);
64
+ ```