mirror of
https://github.com/Gitlawb/openclaude.git
synced 2026-08-24 02:34:15 -05:00
14648213a6
* docs: README cleanup, green wordmark header, Trendshift badges Header: the startup wordmark (src/constants/brand.ts half-block art) rendered as a green two-shade SVG (docs/assets/openclaude-wordmark.svg, textLength-pinned so rows align in any monospace font), with the three Trendshift badges (daily/monthly/repository) centered beneath it. Cleanup (536 -> ~430 lines, nothing lost): - Agent routing, maxSteps limits, and GitHub Copilot sub-agent tuning moved to docs/agent-routing.md; headless gRPC server moved to docs/grpc-server.md; README keeps linked summaries. - Build/test/validation commands were repeated in three sections — consolidated into one Development section; Contributing links to it. - New "Meet Your Buddy" section documenting the companion heroes and their /buddy commands; added to What Works and Why OpenClaude. - Star History moved from the header flow down beside Community. - Setup Guides indexes the new docs pages; fixed a missing blank line before Repository Structure and a curly quote. All relative links, image paths, and internal anchors validated. Co-Authored-By: OpenClaude <openclaude@gitlawb.com> * docs: pure-rect wordmark for crisp rendering; drop broken Star History The wordmark SVG previously drew the half-block art as monospace <text>, which rendered raggedly (font-dependent glyph stretching and seams). Regenerated as pure SVG rects computed from the brand.ts wordmark grid — no font dependence, pixel-crisp at any size, same two-shade green split. Star History chart removed: the badge endpoint errors and displays a broken image. Co-Authored-By: OpenClaude <openclaude@gitlawb.com> * docs: render the wordmark at full README column width Co-Authored-By: OpenClaude <openclaude@gitlawb.com> --------- Co-authored-by: OpenClaude <openclaude@gitlawb.com>
40 lines
1.3 KiB
Markdown
40 lines
1.3 KiB
Markdown
# Headless gRPC Server
|
|
|
|
OpenClaude can be run as a headless gRPC service, allowing you to integrate
|
|
its agentic capabilities (tools, bash, file editing) into other applications,
|
|
CI/CD pipelines, or custom user interfaces. The server uses bidirectional
|
|
streaming to send real-time text chunks, tool calls, and request permissions
|
|
for sensitive commands.
|
|
|
|
## 1. Start the gRPC server
|
|
|
|
Start the core engine as a gRPC service on `localhost:50051`:
|
|
|
|
```bash
|
|
npm run dev:grpc
|
|
```
|
|
|
|
### Configuration
|
|
|
|
| Variable | Default | Description |
|
|
|-----------|-------------|------------------------------------------------|
|
|
| `GRPC_PORT` | `50051` | Port the gRPC server listens on |
|
|
| `GRPC_HOST` | `localhost` | Bind address. Use `0.0.0.0` to expose on all interfaces (not recommended without authentication) |
|
|
|
|
## 2. Run the test CLI client
|
|
|
|
A lightweight CLI client is provided that communicates exclusively over gRPC.
|
|
It acts just like the main interactive CLI, rendering colors, streaming
|
|
tokens, and prompting you for tool permissions (y/n) via the gRPC
|
|
`action_required` event.
|
|
|
|
In a separate terminal, run:
|
|
|
|
```bash
|
|
npm run dev:grpc:cli
|
|
```
|
|
|
|
> **Note:** The gRPC definitions are located in `src/proto/openclaude.proto`.
|
|
> You can use this file to generate clients in Python, Go, Rust, or any other
|
|
> language.
|