Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,4 +117,4 @@ Provider bootstrap, Runtime images and Harness adapters must agree on these name

## Branding

Use OpenAgentCore for public project branding. The canonical mark is `docs/assets/openagentcore-logo.svg`; Web uses its outline with cropped transparent margins, theme-aware favicon colors and dark-surface inversion. The README wordmark is `docs/assets/openagentcore-wordmark-light.svg` with a dark variant, and `docs/assets/og-image.png` is the social preview. The architecture diagram that README and the website show, `docs/assets/architecture.svg` and `architecture-dark.svg`, is generated by `scripts/generate-architecture-diagram.py`; change the script and run it again. The `example/parsar/` example keeps its own name, logo and favicon.
Use OpenAgentCore for public project branding. The canonical mark is `docs/assets/openagentcore-logo.svg`; Web uses its outline with cropped transparent margins, theme-aware favicon colors and dark-surface inversion. The README banner is `docs/assets/openagentcore-banner.webp`, and `docs/assets/og-image.png` is the social preview. The architecture diagram that README and the website show, `docs/assets/architecture.svg` and `architecture-dark.svg`, is generated by `scripts/generate-architecture-diagram.py`; change the script and run it again. The `example/parsar/` example keeps its own name, logo and favicon.
7 changes: 2 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
<div align="center">

<picture>
<source media="(prefers-color-scheme: dark)" srcset="docs/assets/openagentcore-wordmark-dark.svg">
<img alt="OpenAgentCore" src="docs/assets/openagentcore-wordmark-light.svg" width="440">
</picture>
![OpenAgentCore — One core. Many agents.](docs/assets/openagentcore-banner.webp)

The OpenAI Agents API, open source and self-hosted. Run Codex, Claude Code or MiniMax Code on your own machines with your own models, through the official OpenAI SDK.

Expand All @@ -15,7 +12,7 @@ The OpenAI Agents API, open source and self-hosted. Run Codex, Claude Code or Mi

</div>

<p align="center"><img alt="Deployment overview" src="docs/assets/console-overview-en.webp" width="75%"></p>
![Deployment overview](docs/assets/console-overview-en.webp)

- **Same API as OpenAI.** Set `OPENAI_BASE_URL` and the [official OpenAI SDK](https://developers.openai.com/api/docs/libraries), or plain HTTP, works unchanged.
- **Your agent, your model.** Each Session runs Codex, Claude Code or MiniMax Code natively, as it runs on your machine, with the model provider you configure. See [Harness capabilities](https://openagentcore.dev/contracts/agents-api/harness-capabilities).
Expand Down
7 changes: 2 additions & 5 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
<div align="center">

<picture>
<source media="(prefers-color-scheme: dark)" srcset="docs/assets/openagentcore-wordmark-dark.svg">
<img alt="OpenAgentCore" src="docs/assets/openagentcore-wordmark-light.svg" width="440">
</picture>
![OpenAgentCore — One core. Many agents.](docs/assets/openagentcore-banner.webp)

开源、可自部署的 OpenAI Agents API。用官方 OpenAI SDK,在你自己的机器上用你自己的模型运行 Codex、Claude Code 或 MiniMax Code。

Expand All @@ -15,7 +12,7 @@

</div>

<p align="center"><img alt="部署概览" src="docs/assets/console-overview-zh.webp" width="75%"></p>
![部署概览](docs/assets/console-overview-zh.webp)

- **与 OpenAI 相同的 API。** 设置 `OPENAI_BASE_URL` 后,[官方 OpenAI SDK](https://developers.openai.com/api/docs/libraries)或直接的 HTTP 调用无需改动即可使用。
- **你的 Agent,你的模型。** 每个 Session 原生运行 Codex、Claude Code 或 MiniMax Code,使用你配置的模型提供商,与在本机运行一致。详见 [Harness 能力](https://openagentcore.dev/zh/contracts/agents-api/harness-capabilities)。
Expand Down
Binary file added docs/assets/openagentcore-banner.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 0 additions & 1 deletion docs/assets/openagentcore-wordmark-dark.svg

This file was deleted.

1 change: 0 additions & 1 deletion docs/assets/openagentcore-wordmark-light.svg

This file was deleted.

3 changes: 1 addition & 2 deletions scripts/core-distribution-manifest.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,7 @@
)
# Files the bundled docs show, copied as they are, so they work offline.
BUNDLED_FILES = (
"docs/assets/openagentcore-wordmark-light.svg",
"docs/assets/openagentcore-wordmark-dark.svg",
"docs/assets/openagentcore-banner.webp",
"docs/assets/architecture.svg",
"docs/assets/architecture-dark.svg",
"docs/assets/console-overview-en.webp",
Expand Down
Loading