typescript-sdk - GitLite

KO | EN

gitlite — search

#hacktoberfest #android #rust #linux #macos #java #windows #awesome #kubernetes #awesome-list #vue #pytorch #openai #open-source

typescript-sdk

(★ 235)

TypeScript SDK for ACP clients and agents.

파일 탐색기

최종 버전 다운로드 (.zip)

- - 05_bug_report.yml
  - 10_accepted_protocol_changes.yml
  - config.yml
- - ci.yml
  - publish.yml
- dependabot.yml
- - meta.unstable.json
  - schema.unstable.json
- meta.json
- schema.json
- generate.js
- spellcheck.sh
- - agent.ts
  - client.ts
  - dual-version-agent.ts
  - http-client.ts
  - http-server.ts
  - README.md
  - ws-client.ts
- - guards.gen.ts
  - index.ts
  - types.gen.ts
  - zod.gen.ts
- - streams.ts
  - test-agent.ts
  - test-http-server.ts
- - acp.test.ts
  - acp.ts
- acp.test.ts
- acp.ts
- connection.test.ts
- connection.ts
- cookie-store.test.ts
- cookie-store.ts
- http-stream.test.ts
- http-stream.ts
- jsonrpc.test.ts
- jsonrpc.ts
- line-buffer.test.ts
- line-buffer.ts
- node-adapter.test.ts
- node-adapter.ts
- protocol-router.test.ts
- protocol-router.ts
- protocol.test.ts
- protocol.ts
- schema-deserialize.test.ts
- schema-deserialize.ts
- server-permission.test.ts
- server-session-sse.test.ts
- server-sse.test.ts
- server-sse.ts
- server-websocket-upgrade.test.ts
- server.test.ts
- server.ts
- sse.test.ts
- sse.ts
- stream.test.ts
- stream.ts
- typedoc.json
- typedoc.v2.json
- ws-server.ts
- ws-stream.test.ts
- ws-stream.ts
- ws-utils.test.ts
- ws-utils.ts
.gitignore
.prettierignore
.prettierrc
.release-please-manifest.json
AGENTS.md
CHANGELOG.md
eslint.config.js
LICENSE
MIGRATION_0.26_0.27.md
package-lock.json
package.json
README.md
release-please-config.json
tsconfig.json
typos.toml

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/agentclientprotocol/typescript-sdk

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd typescript-sdk

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Node.js

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.

npm install @agentclientprotocol/sdk

package.json에 명시된 라이브러리들을 내려받아 설치합니다.

✅ 명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<a href="https://agentclientprotocol.com/" >
  <img alt="Agent Client Protocol" src="https://zed.dev/img/acp/banner-dark.webp">
</a>

# ACP TypeScript Library

The official TypeScript implementation of the Agent Client Protocol (ACP) — a standardized communication protocol between code editors and AI-powered coding agents.

Learn more at https://agentclientprotocol.com

## Installation

```bash
npm install @agentclientprotocol/sdk
```

## Experimental ACP v2

> **Warning:** ACP v2 is still a draft. Its wire protocol and this TypeScript
> API may change incompatibly in any SDK release. Use it only if you are
> prepared to track the draft as it evolves.

The stable package entry point remains ACP v1. ACP v2 requires an explicit
experimental import:

```ts
import * as acp from "@agentclientprotocol/sdk/experimental/v2";
```

Browse the [experimental v2 TypeScript API reference](https://agentclientprotocol.github.io/typescript-sdk/v2/)
and the [draft ACP v2 protocol documentation](https://agentclientprotocol.com/protocol/v2/draft/overview)
for the current SDK and protocol designs.

## Get Started

### Understand the Protocol

Start by reading the [official ACP documentation](https://agentclientprotocol.com) to understand the core concepts and protocol specification.

### Try the Examples

The [examples directory](https://github.com/agentclientprotocol/typescript-sdk/tree/main/src/examples) contains simple implementations of both Agents and Clients in TypeScript. These examples can be run from your terminal or from an ACP Client like [Zed](https://zed.dev), making them great starting points for your own integration!

### Explore the API

Browse the [TypeScript library reference](https://agentclientprotocol.github.io/typescript-sdk) for detailed API documentation.

If you're building an [Agent](https://agentclientprotocol.com/protocol/overview#agent), start with `agent({ name })`, register handlers such as `initialize(...)`, `newSession(...)`, and `prompt(...)`, then call `connect(stream)`.

If you're building a [Client](https://agentclientprotocol.com/protocol/overview#client), start with `client({ name })`, register client-side handlers such as `requestPermission(...)` and `sessionUpdate(...)`, then run your agent workflow with `connectWith(stream, async (ctx) => ...)`.

### Study a Production Implementation

For a complete, production-ready implementation, check out the [Gemini CLI Agent](https://github.com/google-gemini/gemini-cli/blob/main/packages/cli/src/zed-integration/zedIntegration.ts).

## Resources

- [Library docs](https://agentclientprotocol.github.io/typescript-sdk)
- [Examples](https://github.com/agentclientprotocol/typescript-sdk/tree/main/src/examples)
- [Protocol Documentation](https://agentclientprotocol.com)
- [GitHub Repository](https://github.com/agentclientprotocol/typescript-sdk)
- [NPM Package](https://www.npmjs.com/package/@agentclientprotocol/sdk)

## Contributing

See the main [repository](https://github.com/agentclientprotocol/typescript-sdk) for contribution guidelines.

### License

By contributing, you agree that your contributions will be licensed under the Apache 2.0 License.