wehub/composiohq--composio
1
0
Fork 0
Code Issues Pull Requests Actions Deployments Models Agent Notes Packages Projects Releases Wiki Activity

docs: make Chinese README the default

Browse Source
This commit is contained in:
wehub-resource-sync
2026-07-13 10:31:01 +00:00
parent 3026b1e37d
commit 58fed09d56
1 changed files with 43 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+43 -37
View File
@@ -1,3 +1,9 @@
<!-- WEHUB_ZH_README -->
> [!NOTE]
> 本文档由 WeHub 基于上游 README 翻译整理，属于社区翻译，非官方中文文档。
> [English](./README.en.md) · [原始项目](https://github.com/ComposioHQ/composio) · [上游 README](https://github.com/ComposioHQ/composio/blob/HEAD/README.md)
> 原作者、版权与许可证归属以原始项目及本仓库 LICENSE 文件为准。
<p align="center">
<a href="https://composio.dev">
<picture>
@@ -9,8 +15,8 @@
<p align="center">
<a href="https://composio.dev"><b>composio.dev</b></a> •
<a href="https://docs.composio.dev">Documentation</a> •
<a href="https://docs.composio.dev/docs/quickstart">Quickstart</a>
<a href="https://docs.composio.dev">文档</a> •
<a href="https://docs.composio.dev/docs/quickstart">快速入门</a>
</p>
<p align="center">
@@ -23,18 +29,18 @@
# Composio
Composio gives your AI agents 1000+ pre-authenticated toolkits, per-user sessions, authentication, triggers, and a sandbox, so you can ship agents that turn intent into action.
Composio 为你的 AI 智能体提供 1000+ 个预认证工具包（toolkits）、按用户划分的会话（sessions）、身份认证、触发器（triggers）以及沙箱（sandbox），助你交付能将意图转化为行动的智能体。
This is the Composio SDK monorepo. It contains:
这是 Composio SDK 的 monorepo，包含：
- **[`@composio/core`](ts/packages/core)**: TypeScript SDK
- **[`composio`](python)**: Python SDK
- **[`composio` CLI](ts/packages/cli)**: search, execute, and script tools from your shell
- **Provider adapters** for OpenAI Agents, Claude Agent SDK, Vercel AI SDK, LangChain, and [more](#providers)
- **[`@composio/core`](ts/packages/core)**：TypeScript SDK
- **[`composio`](python)**：Python SDK
- **[`composio` CLI](ts/packages/cli)**：在 shell 中搜索、执行并用脚本编排工具
- **Provider 适配器**，适用于 OpenAI Agents、Claude Agent SDK、Vercel AI SDK、LangChain 等[更多框架](#providers)
## Quickstart
## 快速入门
Create a session for a user, hand its tools to your agent, and let the agent take action across 1000+ apps. Grab a `COMPOSIO_API_KEY` from the [dashboard](https://dashboard.composio.dev/settings) first.
为用户创建会话，将其工具交给你的智能体，让智能体在 1000+ 个应用中执行操作。请先从[控制台](https://dashboard.composio.dev/settings))获取 `COMPOSIO_API_KEY`。
### TypeScript
@@ -42,7 +48,7 @@ Create a session for a user, hand its tools to your agent, and let the agent tak
npm install @composio/core @composio/openai-agents @openai/agents
```
> `@composio/core` intentionally packages its TypeScript source and SDK docs so the installed package is inspectable to coding agents. If you want a smaller install with the same API, use [`@composio/slim`](ts/packages/slim).
> `@composio/core` 有意打包其 TypeScript 源码和 SDK 文档，以便编程智能体可以检查已安装的包。若希望安装体积更小且 API 相同，请使用 [`@composio/slim`](ts/packages/slim)。
```typescript
import { Composio } from "@composio/core";
@@ -92,24 +98,24 @@ result = Runner.run_sync(starting_agent=agent, input="Summarize my emails from t
print(result.final_output)
```
By default a session gets meta tools that discover, authenticate, and execute app tools at runtime, so you don't load hundreds of tool definitions into context. Store `session.session_id` and reuse it with `composio.use()` across turns. See [what a session is](https://docs.composio.dev/docs/how-composio-works) and [configuring sessions](https://docs.composio.dev/docs/configuring-sessions) for restricting toolkits, auth configs, and connected accounts.
默认情况下，会话会获得用于在运行时发现、认证并执行应用工具的 meta tools，因此你无需将数百个工具定义加载到上下文中。存储 `session.session_id`，并在多轮对话中通过 `composio.use()` 复用。请参阅[什么是会话](https://docs.composio.dev/docs/how-composio-works))和[配置会话](https://docs.composio.dev/docs/configuring-sessions))，以限制工具包、认证配置和已连接账户。
**Prefer MCP?** Every session also exposes a hosted MCP endpoint. Pass `mcp: true` to `composio.create()` and point Claude, Cursor, or any MCP client at `session.mcp.url`. See [sessions via MCP](https://docs.composio.dev/docs/sessions-via-mcp).
**更喜欢 MCP？** 每个会话还会暴露一个托管 MCP 端点。将 `mcp: true` 传给 `composio.create()`，并让 Claude、Cursor 或任意 MCP 客户端指向 `session.mcp.url`。请参阅[通过 MCP 使用会话](https://docs.composio.dev/docs/sessions-via-mcp).)
## CLI
The `composio` CLI runs Composio from your shell and gives coding agents like Claude Code a local tool surface.
`composio` CLI 可在 shell 中运行 Composio，并为 Claude Code 等编程智能体提供本地工具接口。
```bash
curl -fsSL https://composio.dev/install | bash
composio login
```
Use `composio search` to find tools, `composio execute` to run them, `composio link` to connect accounts, and `composio run` to script workflows in TypeScript. See the [CLI docs](https://docs.composio.dev/docs/cli).
使用 `composio search` 查找工具，`composio execute` 运行工具，`composio link` 连接账户，`composio run` 用 TypeScript 编写工作流脚本。请参阅 [CLI 文档](https://docs.composio.dev/docs/cli).)
## Providers
A provider adapts Composio tools to your agent framework's native tool format:
Provider 将 Composio 工具适配为你所用智能体框架的原生工具格式：
| Provider | TypeScript | Python |
|----------|:----------:|:------:|
@@ -129,26 +135,26 @@ A provider adapts Composio tools to your agent framework's native tool format:
| CrewAI | — | [`composio-crewai`](python/providers/crewai) |
| AutoGen | — | [`composio-autogen`](python/providers/autogen) |
\* *The [Pi provider](https://docs.composio.dev/docs/providers/pi) is experimental and ships from `@composio/experimental`.*
\* *[Pi provider](https://docs.composio.dev/docs/providers/pi)) 为实验性功能，由 `@composio/experimental` 发布。*
Don't see your framework? [Build a custom provider](https://docs.composio.dev/docs/providers/custom-providers), or skip providers entirely and connect over [MCP](https://docs.composio.dev/docs/sessions-via-mcp).
找不到你的框架？[构建自定义 Provider](https://docs.composio.dev/docs/providers/custom-providers),)，或完全跳过 Provider，直接通过 [MCP](https://docs.composio.dev/docs/sessions-via-mcp).) 连接。
## All packages
## 全部软件包
Everything published from this repo:
本仓库发布的所有内容：
| Package | Description |
| Package | 说明 |
|---------|-------------|
| [`@composio/core`](ts/packages/core) | TypeScript SDK |
| [`@composio/slim`](ts/packages/slim) | `@composio/core` without packaged source or docs; same API, smaller install |
| [`composio` CLI](ts/packages/cli) | Standalone CLI binary: `curl -fsSL https://composio.dev/install \| bash` |
| [`@composio/experimental`](ts/packages/experimental) | Experimental integrations, including the Pi provider |
| [`@composio/json-schema-to-zod`](ts/packages/json-schema-to-zod) | JSON Schema to Zod conversion |
| `@composio/*` [provider adapters](#providers) | OpenAI, OpenAI Agents, Anthropic, Claude Agent SDK, Vercel, Google, LangChain, LlamaIndex, Mastra, Cloudflare |
| [`@composio/slim`](ts/packages/slim) | `@composio/core`，不含打包的源码或文档；API 相同，安装体积更小 |
| [`composio` CLI](ts/packages/cli) | 独立 CLI 二进制：`curl -fsSL https://composio.dev/install \| bash` |
| [`@composio/experimental`](ts/packages/experimental) | 实验性集成，包括 Pi provider |
| [`@composio/json-schema-to-zod`](ts/packages/json-schema-to-zod) | JSON Schema 转 Zod 转换 |
| `@composio/*` [provider adapters](#providers) | OpenAI、OpenAI Agents、Anthropic、Claude Agent SDK、Vercel、Google、LangChain、LlamaIndex、Mastra、Cloudflare |
| [`composio`](python) | Python SDK |
| `composio-*` [provider adapters](#providers) | OpenAI, OpenAI Agents, Anthropic, Claude Agent SDK, Gemini, Google, Google ADK, LangChain, LangGraph, LlamaIndex, CrewAI, AutoGen |
| `composio-*` [provider adapters](#providers) | OpenAI、OpenAI Agents、Anthropic、Claude Agent SDK、Gemini、Google、Google ADK、LangChain、LangGraph、LlamaIndex、CrewAI、AutoGen |
## Repository layout
## 仓库结构
```text
ts/ TypeScript SDK workspace
@@ -159,9 +165,9 @@ python/ Python SDK and provider packages
docs/ Documentation site (docs.composio.dev)
```
The TypeScript SDK is tested against Node 22+; the Python SDK supports Python 3.10+.
TypeScript SDK 在 Node 22+ 上测试；Python SDK 支持 Python 3.10+。
## Development
## 开发
```bash
mise install # pinned toolchain (Node, Python, pnpm)
@@ -170,15 +176,15 @@ pnpm build
pnpm test
```
Python commands run from `python/`; see [`python/README.md`](python/README.md). We welcome contributions to both SDKs; read the [contribution guidelines](CONTRIBUTING.md) before submitting pull requests.
Python 命令从 `python/` 运行；详见 [`python/README.md`](python/README.md)。我们欢迎为两个 SDK 贡献代码；提交 pull request 前请先阅读 [贡献指南](CONTRIBUTING.md)。
## Support
## 支持
- [Documentation](https://docs.composio.dev)
- [Discord community](https://discord.gg/composio)
- [Open an issue](https://github.com/ComposioHQ/composio/issues)
- [文档](https://docs.composio.dev)
- [Discord 社区](https://discord.gg/composio)
- [提交 Issue](https://github.com/ComposioHQ/composio/issues)
- [support@composio.dev](mailto:support@composio.dev)
## License
## 许可证
MIT. See [LICENSE](LICENSE).
MIT。详见 [LICENSE](LICENSE)。