@grackle-ai/common 0.70.0 → 0.70.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +35 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,5 +1,38 @@
|
|
|
1
1
|
# @grackle-ai/common
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Shared Protocol Buffer definitions, generated TypeScript code, and common types for the [Grackle](https://github.com/nick-pape/grackle) platform.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Grackle is an open-source platform for running AI coding agents on remote environments — Docker, SSH, GitHub Codespaces, and more. This package provides the core protocol and type definitions that all Grackle packages depend on.
|
|
6
|
+
|
|
7
|
+
## Installation
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install @grackle-ai/common
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## What's Inside
|
|
14
|
+
|
|
15
|
+
- **Protocol Buffer definitions** for the `Grackle` (central server) and `GracklePowerLine` (remote agent) gRPC services, compiled to TypeScript via [ConnectRPC](https://connectrpc.com/)
|
|
16
|
+
- **Generated TypeScript code** for all gRPC messages, enums, and service descriptors — ready to use with `@connectrpc/connect`
|
|
17
|
+
- **Shared types and constants** used across the CLI, server, web UI, and PowerLine packages — status enums, default ports, configuration paths, and more
|
|
18
|
+
- **Enum converters** for translating between string representations (used in SQLite and WebSocket payloads) and protobuf enum values (used in gRPC messages)
|
|
19
|
+
- **Runtime manifests** describing the npm packages required by each supported agent runtime (Claude Code, Copilot, Codex, Goose, and others)
|
|
20
|
+
- **Fuzzy search** utility for client-side and server-side filtering
|
|
21
|
+
|
|
22
|
+
## Usage
|
|
23
|
+
|
|
24
|
+
Import the generated proto namespaces and shared types:
|
|
25
|
+
|
|
26
|
+
```typescript
|
|
27
|
+
import { grackle, powerline } from "@grackle-ai/common";
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
The `grackle` namespace contains the central server service definition and all associated message types. The `powerline` namespace contains the remote agent service definition.
|
|
31
|
+
|
|
32
|
+
## Requirements
|
|
33
|
+
|
|
34
|
+
- Node.js >= 22
|
|
35
|
+
|
|
36
|
+
## License
|
|
37
|
+
|
|
38
|
+
MIT
|