Skip to content

Commit c50b85a

Browse files
authored
chore(sdk): rename project to Remote Agents SDK (#113)
## What <!-- Brief description of the changes --> Rename this project (and publish targets) to Remote Agents SDK (npm: `@runloop/remote-agents-sdk`; github: `runloopai/remote-agents-sdk`) ## Why <!-- Motivation and context --> ## PR title format <!-- PR titles must follow Conventional Commits: <type>(<scope>): <description> Types: feat | fix | docs | style | refactor | perf | test | build | ci | chore | revert Scopes: sdk | acp | claude | examples | deps | project Examples: feat(sdk): add reconnect support fix(acp): handle timeout on long-running tasks docs(claude): update connection examples deps(sdk): bump @runloop/api-client to 1.5.0 ci(project): add PR title validation workflow --> ## Checklist - [ ] PR title follows `<type>(<scope>): <description>` format (see above) - [ ] `bun run check` passes (lint + format) - [ ] `bun run build` passes - [ ] `bun run test` passes - [ ] SDK documentation updated (if applicable)
1 parent f4ad944 commit c50b85a

57 files changed

Lines changed: 193 additions & 192 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: Bug report
3-
about: Report a bug in @runloop/agent-axon-client
3+
about: Report a bug in @runloop/remote-agents-sdk
44
title: ''
55
labels: bug
66
assignees: ''
@@ -26,7 +26,7 @@ What actually happened. Include any error messages or stack traces.
2626

2727
## Environment
2828

29-
- `@runloop/agent-axon-client` version:
29+
- `@runloop/remote-agents-sdk` version:
3030
- Node.js version:
3131
- OS:
3232
- Package manager and version:

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,5 @@ contact_links:
44
url: https://runloop.ai/docs
55
about: Check the docs for usage guides and API reference.
66
- name: Discussions
7-
url: https://github.com/runloopai/agent-axon-client-ts/discussions
7+
url: https://github.com/runloopai/remote-agents-sdk/discussions
88
about: Ask questions and share ideas in GitHub Discussions.

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: Feature request
3-
about: Suggest a new feature or improvement for @runloop/agent-axon-client
3+
about: Suggest a new feature or improvement for @runloop/remote-agents-sdk
44
title: ''
55
labels: enhancement
66
assignees: ''

.github/workflows/ci.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ jobs:
3030
- run: bun install --frozen-lockfile
3131

3232
- name: Lint and format check
33-
run: bun run --filter '@runloop/agent-axon-client' check
33+
run: bun run --filter '@runloop/remote-agents-sdk' check
3434

3535
- name: Build
3636
run: bun run build
@@ -43,7 +43,7 @@ jobs:
4343
bun run --filter '@runloop/example-combined-app' build
4444
4545
- name: Test with coverage
46-
run: bun run --filter '@runloop/agent-axon-client' test:coverage
46+
run: bun run --filter '@runloop/remote-agents-sdk' test:coverage
4747

4848
- name: Upload coverage
4949
if: matrix.node-version == 22

.github/workflows/docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ jobs:
4040
run: bun run build
4141

4242
- name: Generate docs
43-
run: bun run --filter '@runloop/agent-axon-client' docs
43+
run: bun run --filter '@runloop/remote-agents-sdk' docs
4444

4545
- uses: actions/configure-pages@v5
4646

.release-please-manifest.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
{
2-
"sdk": "0.4.2"
2+
"sdk": "0.4.3"
33
}

AGENTS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# AGENTS.md — agent-axon-client-ts
1+
# AGENTS.md — remote-agents-sdk
22

33
Repo guide for AI agents. SDK API docs: [`sdk/AGENTS.md`](sdk/AGENTS.md).
44

55
## Layout
66

7-
- `sdk/``@runloop/agent-axon-client` (published package)
7+
- `sdk/``@runloop/remote-agents-sdk` (published package)
88
- `examples/feature-examples/` — runnable SDK recipes
99
- `examples/` — demo apps (hello-world, CLI, full-stack)
1010

CONTRIBUTING.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Contributing
22

3-
Thanks for your interest in contributing to `@runloop/agent-axon-client`.
3+
Thanks for your interest in contributing to `@runloop/remote-agents-sdk`.
44

55
## Prerequisites
66

@@ -10,8 +10,8 @@ Thanks for your interest in contributing to `@runloop/agent-axon-client`.
1010
## Getting Started
1111

1212
```bash
13-
git clone git@github.com:runloopai/agent-axon-client-ts.git
14-
cd agent-axon-client-ts
13+
git clone git@github.com:runloopai/remote-agents-sdk.git
14+
cd remote-agents-sdk
1515
bun install
1616
bun run build
1717
```
@@ -20,7 +20,7 @@ bun run build
2020

2121
This is a Bun workspaces monorepo:
2222

23-
- **`sdk/`** — The published `@runloop/agent-axon-client` package. All SDK source lives in `sdk/src/`.
23+
- **`sdk/`** — The published `@runloop/remote-agents-sdk` package. All SDK source lives in `sdk/src/`.
2424
- **`examples/`** — Example applications that consume the SDK. These are private packages and are not published.
2525

2626
## Development Workflow
@@ -32,19 +32,19 @@ This is a Bun workspaces monorepo:
3232
bun run build
3333

3434
# Watch mode (rebuilds on changes)
35-
bun run --filter '@runloop/agent-axon-client' dev
35+
bun run --filter '@runloop/remote-agents-sdk' dev
3636

3737
# Run tests
3838
bun run test
3939

4040
# Run tests in watch mode
41-
bun run --filter '@runloop/agent-axon-client' test:watch
41+
bun run --filter '@runloop/remote-agents-sdk' test:watch
4242

4343
# Lint and format check
4444
bun run check
4545

4646
# Auto-fix lint and formatting issues
47-
bun run --filter '@runloop/agent-axon-client' check:fix
47+
bun run --filter '@runloop/remote-agents-sdk' check:fix
4848
```
4949

5050
### Working on examples

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
# @runloop/agent-axon-client
1+
# @runloop/remote-agents-sdk
22

3-
[![CI](https://github.com/runloopai/agent-axon-client-ts/actions/workflows/ci.yml/badge.svg)](https://github.com/runloopai/agent-axon-client-ts/actions/workflows/ci.yml)
4-
[![npm](https://img.shields.io/npm/v/@runloop/agent-axon-client)](https://www.npmjs.com/package/@runloop/agent-axon-client)
5-
[![Docs](https://img.shields.io/badge/docs-TypeDoc-blue)](https://runloopai.github.io/agent-axon-client-ts/)
6-
[![codecov](https://codecov.io/gh/runloopai/agent-axon-client-ts/branch/main/graph/badge.svg)](https://codecov.io/gh/runloopai/agent-axon-client-ts)
3+
[![CI](https://github.com/runloopai/remote-agents-sdk/actions/workflows/ci.yml/badge.svg)](https://github.com/runloopai/remote-agents-sdk/actions/workflows/ci.yml)
4+
[![npm](https://img.shields.io/npm/v/@runloop/remote-agents-sdk)](https://www.npmjs.com/package/@runloop/remote-agents-sdk)
5+
[![Docs](https://img.shields.io/badge/docs-TypeDoc-blue)](https://runloopai.github.io/remote-agents-sdk/)
6+
[![codecov](https://codecov.io/gh/runloopai/remote-agents-sdk/branch/main/graph/badge.svg)](https://codecov.io/gh/runloopai/remote-agents-sdk)
77
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
88

99
> **Alpha — subject to change.** This SDK is in early development. APIs, interfaces, and behavior may change without notice between versions.
1010
11-
TypeScript SDK for connecting to coding agents (Claude Code, OpenCode, etc.) running inside [Runloop](https://runloop.ai) devboxes via the Axon event bus.
11+
TypeScript SDK for connecting applications to Runloop-hosted remote agents (Claude Code, OpenCode, etc.) via the Axon event bus.
1212

1313
## Key Concepts
1414

@@ -38,7 +38,7 @@ In short: **Runloop** hosts **devboxes** where agents run; a **broker mount** co
3838
## Installation
3939

4040
```bash
41-
npm install @runloop/agent-axon-client @runloop/api-client
41+
npm install @runloop/remote-agents-sdk @runloop/api-client
4242
```
4343

4444
`@runloop/api-client` is a required peer dependency — it provides the `RunloopSDK` instance and Axon types used by both modules.
@@ -90,8 +90,8 @@ The SDK has two independent modules — pick the one that matches your agent's p
9090

9191
| Module | Import path | Protocol | Use when |
9292
| ---------- | ----------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------- |
93-
| **ACP** | `@runloop/agent-axon-client/acp` | [Agent Client Protocol](https://agentclientprotocol.com) (JSON-RPC 2.0) | Using OpenCode, or Claude via ACP |
94-
| **Claude** | `@runloop/agent-axon-client/claude` | Claude Code SDK wire format | Using Claude Code with native SDK message types |
93+
| **ACP** | `@runloop/remote-agents-sdk/acp` | [Agent Client Protocol](https://agentclientprotocol.com) (JSON-RPC 2.0) | Using OpenCode, or Claude via ACP |
94+
| **Claude** | `@runloop/remote-agents-sdk/claude` | Claude Code SDK wire format | Using Claude Code with native SDK message types |
9595

9696

9797
### Which module should I use?
@@ -115,7 +115,7 @@ The SDK has two independent modules — pick the one that matches your agent's p
115115
### ACP module
116116

117117
```typescript
118-
import { ACPAxonConnection, PROTOCOL_VERSION, isAgentMessageChunk } from "@runloop/agent-axon-client/acp";
118+
import { ACPAxonConnection, PROTOCOL_VERSION, isAgentMessageChunk } from "@runloop/remote-agents-sdk/acp";
119119
import { RunloopSDK } from "@runloop/api-client";
120120

121121
const sdk = new RunloopSDK({ bearerToken: process.env.RUNLOOP_API_KEY });
@@ -160,7 +160,7 @@ await agent.disconnect();
160160
### Claude module
161161

162162
```typescript
163-
import { ClaudeAxonConnection } from "@runloop/agent-axon-client/claude";
163+
import { ClaudeAxonConnection } from "@runloop/remote-agents-sdk/claude";
164164
import { RunloopSDK } from "@runloop/api-client";
165165

166166
const sdk = new RunloopSDK({ bearerToken: process.env.RUNLOOP_API_KEY });
@@ -197,12 +197,12 @@ Every timeline event has `{ kind, data, axonEvent }` where `kind` is a discrimin
197197
**ACP — handling protocol events:**
198198

199199
```typescript
200-
import { SYSTEM_EVENT_TYPES } from "@runloop/agent-axon-client/shared";
200+
import { SYSTEM_EVENT_TYPES } from "@runloop/remote-agents-sdk/shared";
201201
import {
202202
isAgentMessageChunk,
203203
isToolCall,
204204
isToolCallProgress,
205-
} from "@runloop/agent-axon-client/acp";
205+
} from "@runloop/remote-agents-sdk/acp";
206206

207207
agent.onTimelineEvent((event) => {
208208
switch (event.kind) {
@@ -249,7 +249,7 @@ conn.onTimelineEvent((event) => {
249249
**Custom events** — use `publish()` to push your own events to the channel. They arrive as `kind: "unknown"` timeline events:
250250

251251
```typescript
252-
import { tryParseTimelinePayload } from "@runloop/agent-axon-client/acp";
252+
import { tryParseTimelinePayload } from "@runloop/remote-agents-sdk/acp";
253253

254254
// Publish a custom event
255255
await conn.publish({
@@ -278,7 +278,7 @@ for await (const event of agent.receiveTimelineEvents()) {
278278

279279
See the [SDK documentation](sdk/README.md#custom-events-via-publish-and-tryparsetimelinepayload) for more on custom events, and the [full timeline API reference](sdk/README.md#timeline-events) for replay behavior and `afterSequence`.
280280

281-
See the [SDK documentation](sdk/README.md) for the full API reference, or browse the [hosted API docs](https://runloopai.github.io/agent-axon-client-ts/).
281+
See the [SDK documentation](sdk/README.md) for the full API reference, or browse the [hosted API docs](https://runloopai.github.io/remote-agents-sdk/).
282282

283283
## Getting Agents onto the Devbox
284284

@@ -292,7 +292,7 @@ The standalone examples (hello-world, CLI, combined-app) use a pre-baked **bluep
292292
## Repository Structure
293293

294294
```
295-
sdk/ → @runloop/agent-axon-client (the published npm package)
295+
sdk/ → @runloop/remote-agents-sdk (the published npm package)
296296
examples/
297297
blueprint/ → Builds the shared `axon-agents` blueprint (run this first)
298298
acp-hello-world/ → Minimal ACP single-prompt script

SECURITY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,6 @@ mitigation plan within 7 days.
2222

2323
## Scope
2424

25-
This policy covers the `@runloop/agent-axon-client` SDK package. Security
25+
This policy covers the `@runloop/remote-agents-sdk` SDK package. Security
2626
issues in third-party dependencies should be reported upstream, though we
2727
appreciate a heads-up if they affect this project.

0 commit comments

Comments
 (0)