Skip to content

Commit a85fe7f

Browse files
committed
docs(profile): refresh org README (EN/ZH) for effector monorepo
Made-with: Cursor
1 parent 9542365 commit a85fe7f

2 files changed

Lines changed: 58 additions & 8 deletions

File tree

profile/README.md

Lines changed: 33 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,10 @@
55
<p align="center"><strong>We build hands for AI that moves first.</strong></p>
66

77
<p align="center">
8+
<a href="https://www.npmjs.com/package/@effectorhq/cli"><img src="https://img.shields.io/npm/v/@effectorhq/cli?label=%40effectorhq%2Fcli&color=E03E3E" alt="npm @effectorhq/cli"></a>
89
<a href="https://www.npmjs.com/package/@effectorhq/core"><img src="https://img.shields.io/npm/v/@effectorhq/core?label=%40effectorhq%2Fcore&color=E03E3E" alt="npm @effectorhq/core"></a>
910
<a href="https://github.com/effectorHQ/.github/blob/main/CONTRIBUTING.md"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" alt="PRs Welcome"></a>
10-
<img src="https://img.shields.io/github/last-commit/effectorHQ/effector-core" alt="Last Commit" />
11+
<a href="https://github.com/effectorHQ/effector"><img src="https://img.shields.io/badge/monorepo-effector-1A1A1A.svg" alt="Monorepo"></a>
1112
<a href="https://awesome.re"><img src="https://awesome.re/badge.svg" alt="Awesome"></a>
1213
<a href="https://github.com/effectorHQ/.github/blob/main/CODE_OF_CONDUCT.md"><img src="https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg" alt="Code of Conduct"></a>
1314
<a href="https://github.com/effectorHQ/.github/blob/main/profile/README.zh.md"><img src="https://img.shields.io/badge/文档-中文-red.svg" alt="中文文档"></a>
@@ -30,19 +31,42 @@ graph LR
3031

3132
We don't build the brain (that's the LLM). We don't build the body (that's the runtime — [OpenClaw](https://github.com/openclaw/openclaw), [Claude Agent SDK](https://github.com/anthropics/claude-agent-sdk-python), and whatever comes next). We build the hands — and we make sure every hand is safer, more composable, and more powerful than what existed before.
3233

34+
### [`effector`](https://github.com/effectorHQ/effector) — the unified builder kit
35+
36+
> **One repo. One CLI. One manifest. Every runtime.**
37+
>
38+
> The [`effector`](https://github.com/effectorHQ/effector) monorepo consolidates the core toolchain into a single install path. All packages below (core, types, audit, compose, serve, lint) ship together, test together, and release together.
39+
40+
```bash
41+
# The golden path — 30 seconds to typed, audited, compiled
42+
npx @effectorhq/cli init my-skill # scaffold a typed skill manifest
43+
cd my-skill
44+
effector check . # validate + type-check + lint + audit
45+
effector compile . -t mcp # compile to MCP tool schema
46+
effector compile . -t openai-agents # compile to OpenAI Agents
47+
effector compile . -t langchain # compile to LangChain (Python)
48+
```
49+
50+
```
51+
┌───────────────┐ ┌──────────────┐ ┌──────────────┐
52+
│ effector.toml │────▶│ check │────▶│ compile │
53+
│ SKILL.md │ │ types/lint/ │ │ mcp/openai/ │
54+
└───────────────┘ │ audit │ │ langchain │
55+
└──────────────┘ └──────────────┘
56+
```
57+
58+
You can also use individual packages directly:
59+
3360
```bash
34-
# Get started in 30 seconds
35-
npm install @effectorhq/core # parse, validate, type-check, compile
36-
npx @effectorhq/create-effector my-skill # scaffold a new effector
37-
npx @effectorhq/skill-lint . # lint before you ship
38-
npx @effectorhq/studio # visual tool builder (browser UI)
39-
npx @effectorhq/graph spectrum # visualize the 40-type capability map
61+
npm install @effectorhq/core # zero-dep kernel: parse, validate, compile
62+
npx @effectorhq/studio # visual tool builder (browser UI)
63+
npx @effectorhq/graph spectrum # visualize the 40-type capability map
4064
```
4165

4266
Quick read: [Typed AI Agent Tools](https://github.com/effectorHQ/docs/blob/main/blog/typed-ai-agent-tools.md) · [v1.0 release announcement](https://github.com/effectorHQ/.github/discussions/8)
4367

4468
End-to-end compile examples:
45-
- [MCP](https://github.com/effectorHQ/effector-core/tree/main/examples/compile-to-mcp)
69+
- [MCP](https://github.com/effectorHQ/effector/tree/main/examples/hello-skill)
4670
- [OpenAI Agents](https://github.com/effectorHQ/effector-core/tree/main/examples/compile-to-openai-agents)
4771
- [LangChain](https://github.com/effectorHQ/effector-core/tree/main/examples/compile-to-langchain)
4872
- [JSON IR](https://github.com/effectorHQ/effector-core/tree/main/examples/compile-to-json)
@@ -57,6 +81,7 @@ The core thesis: AI agent capabilities need types. Today you chain two skills an
5781

5882
| Project | What it is | Status |
5983
|---------|-----------|--------|
84+
| [`effector`](https://github.com/effectorHQ/effector) | **Monorepo & unified CLI** — one install, one tool: `init`, `check`, `compile`, `inspect`, `serve`. Consolidates core + types + audit + compose + lint + serve · [`npx @effectorhq/cli`](https://npmjs.com/package/@effectorhq/cli) | [![npm](https://img.shields.io/npm/v/@effectorhq/cli?color=E03E3E&label=)](https://npmjs.com/package/@effectorhq/cli) |
6085
| [`effector-core`](https://github.com/effectorHQ/effector-core) | **Shared kernel** — TOML/SKILL parser, type checker, schema validator, cross-runtime compiler · [`npm i @effectorhq/core`](https://npmjs.com/package/@effectorhq/core) | [![npm](https://img.shields.io/npm/v/@effectorhq/core?color=E03E3E&label=)](https://npmjs.com/package/@effectorhq/core) |
6186
| [`effector-spec`](https://github.com/effectorHQ/effector-spec) | **The Specification** — type language, composition algebra, discovery protocol | v0.2.1 |
6287
| [`effector-types`](https://github.com/effectorHQ/effector-types) | **Standard capability types** — the `lib.d.ts` for agent tools, grounded in 13K+ skills · [`npm i @effectorhq/types`](https://npmjs.com/package/@effectorhq/types) | [![npm](https://img.shields.io/npm/v/@effectorhq/types?color=E03E3E&label=)](https://npmjs.com/package/@effectorhq/types) |

profile/README.zh.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,30 @@ effectorHQ 是一个开放工作室,构建下一代 AI agent 能力基础设
1717

1818
我们不做大脑(那是 LLM 的事)。我们不做身体(那是 runtime 的事——[OpenClaw](https://github.com/openclaw/openclaw)、Claude Agent SDK、以及未来的一切)。我们做手——并且确保每一只手都比之前更安全、更可组合、更强大。
1919

20+
### [`effector`](https://github.com/effectorHQ/effector) — 统一构建套件
21+
22+
> **一个仓库。一个 CLI。一个 manifest。所有 runtime。**
23+
>
24+
> [`effector`](https://github.com/effectorHQ/effector) monorepo 将核心工具链整合为一个安装路径。下面所有包(core、types、audit、compose、serve、lint)一起发布、一起测试、一起发版。
25+
26+
```bash
27+
# 黄金路径 — 30 秒完成 类型化 + 审计 + 编译
28+
npx @effectorhq/cli init my-skill # 创建类型化 skill manifest
29+
cd my-skill
30+
effector check . # 校验 + 类型检查 + lint + 审计
31+
effector compile . -t mcp # 编译为 MCP tool schema
32+
effector compile . -t openai-agents # 编译为 OpenAI Agents
33+
effector compile . -t langchain # 编译为 LangChain (Python)
34+
```
35+
36+
```
37+
┌───────────────┐ ┌──────────────┐ ┌──────────────┐
38+
│ effector.toml │────▶│ check │────▶│ compile │
39+
│ SKILL.md │ │ types/lint/ │ │ mcp/openai/ │
40+
└───────────────┘ │ audit │ │ langchain │
41+
└──────────────┘ └──────────────┘
42+
```
43+
2044
---
2145

2246
### Effector 类型系统
@@ -25,6 +49,7 @@ effectorHQ 是一个开放工作室,构建下一代 AI agent 能力基础设
2549

2650
| 项目 | 定位 |
2751
|------|------|
52+
| [`effector`](https://github.com/effectorHQ/effector) | **Monorepo & 统一 CLI** — 一个安装,一个工具:`init``check``compile``inspect``serve`。整合 core + types + audit + compose + lint + serve(`npx @effectorhq/cli`|
2853
| [`effector-core`](https://github.com/effectorHQ/effector-core) | **共享内核** — TOML/SKILL 解析、类型检查、schema 校验、跨 runtime 编译(`@effectorhq/core`)。 |
2954
| [`effector-spec`](https://github.com/effectorHQ/effector-spec) | **Effector 规范** — 类型语言、组合代数、发现协议。旗舰项目。 |
3055
| [`effector-types`](https://github.com/effectorHQ/effector-types) | **标准能力类型库** — AI agent 工具的 `lib.d.ts``@effectorhq/types`),包括输入/输出/上下文类型。 |

0 commit comments

Comments
 (0)