OpenControl 项目教程

OpenControl 项目教程

opencontrol ▦ Create tools for any LLM 项目地址: https://gitcode.com/gh_mirrors/op/opencontrol

1. 目录结构及介绍

OpenControl 项目的目录结构如下：

opencontrol/
├── .changeset/
├── .github/
│   └── workflows/
├── app/
├── examples/
│   └── bun/
├── infra/
├── packages/
├── scripts/
├── www/
├── .gitignore
├── CLAUDE.md
├── LICENSE
├── README.md
├── bun.lock
├── bunfig.toml
├── package.json
├── sst-env.d.ts
├── sst.config.ts
└── tsconfig.json

• .changeset/: 包含项目变更记录的目录。
• .github/workflows/: 存放 GitHub Actions 工作流的目录。
• app/: 主应用程序代码目录。
• examples/: 示例代码目录，包括 bun 子目录。
• infra/: 基础设施相关代码。
• packages/: 外部依赖包的目录。
• scripts/: 脚本文件目录。
• www/: 网站静态资源目录。
• .gitignore: 指定 Git 忽略的文件和目录。
• CLAUDE.md: 项目的介绍文件。
• LICENSE: 项目使用的许可证文件。
• README.md: 项目的主要说明文件。
• bun.lock: Bun 包管理器的锁定文件。
• bunfig.toml: Bun 包管理器的配置文件。
• package.json: Node.js 项目配置文件。
• sst-env.d.ts: SST 环境类型定义文件。
• sst.config.ts: SST 配置文件。
• tsconfig.json: TypeScript 配置文件。

2. 项目的启动文件介绍

项目的启动文件是 src/opencontrol.ts。以下是启动文件的基本结构：

import { create } from "opencontrol";
import { handle } from "hono/aws-lambda";

const app = create({
  // model: ...,
  // tools: [ ]
});

export const handler = handle(app);

在 src/opencontrol.ts 文件中，我们首先导入 opencontrol 和 hono/aws-lambda 模块。然后使用 create 函数创建一个 OpenControl 应用实例。create 函数接受一个配置对象，可以设置模型和工具。最后，我们导出一个处理函数 handler，该函数用于处理 AWS Lambda 触发的事件。

3. 项目的配置文件介绍

项目的配置文件包括 sst.config.ts 和 tsconfig.json。

• sst.config.ts: SST (Serverless Stack) 配置文件，用于定义 SST 项目的基础设施和部署设置。以下是一个简单的配置示例：

import { Secret } from "sst";

const anthropicKey = new Secret("AnthropicKey");

export default {
  config: {
    // 其他 SST 配置...
  },
  stacks: {
    MyStack: {
      // 堆栈配置...
    },
  },
};

在 sst.config.ts 中，我们定义了一个秘密 AnthropicKey，该秘密用于存储 Anthropic API 密钥。然后，我们导出项目的配置和堆栈配置。

• tsconfig.json: TypeScript 配置文件，用于指定 TypeScript 编译器的选项。以下是一个基本的配置示例：

{
  "compilerOptions": {
    "target": "ES2017",
    "module": "commonjs",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true
  }
}

在 tsconfig.json 中，我们设置了一些 TypeScript 编译器选项，比如目标代码版本、模块系统、严格模式和模块互操作性设置。

以上就是 OpenControl 项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助您更好地理解和使用该项目。

opencontrol ▦ Create tools for any LLM 项目地址: https://gitcode.com/gh_mirrors/op/opencontrol