plit 0.3.2

Pipelit ecosystem CLI and gateway — install, start, and chat with AI agents
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154

# plit

Pipelit ecosystem CLI

[![Crates.io](https://img.shields.io/crates/v/plit)](https://crates.io/crates/plit)
[![CI](https://github.com/theuselessai/plit/actions/workflows/ci.yml/badge.svg)](https://github.com/theuselessai/plit/actions)
[![License](https://img.shields.io/badge/license-Apache%202.0-blue)](LICENSE)

> **Linux only.** `plit` uses `bwrap` for sandboxing and does not run on macOS.

---

## Install

```sh
cargo install plit
```

This installs two binaries: `plit` (the CLI) and `plit-gw` (the gateway server).

---

## Quick start

```sh
# 1. Interactive setup: configure Pipelit, your LLM provider, and credentials
plit init

# 2. Start the gateway, Pipelit, and workers
plit start
```

That's it. You're running.

---

## Commands

### `plit init`

Interactive wizard. Walks you through:

- Connecting to your Pipelit instance
- Configuring an LLM provider
- Creating initial credentials

Run this once before anything else.

### `plit start` / `plit stop`

Start and stop the full stack: gateway, Pipelit, and background workers. Managed via honcho.

```sh
plit start
plit stop
```

### `plit chat`

Interactive REPL for chatting with your configured agent.

```sh
plit chat my_credential --chat-id session-1
```

### `plit send`

One-shot message. Pipe-friendly.

```sh
plit send my_credential --chat-id session-1 --text "Hello"
echo "summarize this" | plit send my_credential --chat-id session-1
```

Output is plain text on a TTY, JSON when piped. Pass `--json` to force JSON anywhere.

### `plit listen`

Stream incoming messages as JSONL over WebSocket. Useful for scripting and log tailing.

```sh
plit listen my_credential --chat-id session-1
plit listen my_credential --chat-id session-1 | jq .
```

### `plit credentials`

Manage gateway credentials.

```sh
plit credentials list
plit credentials create --name my-bot
plit credentials activate <id>
plit credentials deactivate <id>
```

### `plit health`

Check gateway and backend health.

```sh
plit health
```

### `plit uninstall`

Remove configuration and stop running services.

```sh
plit uninstall
```

---

## Environment variables

| Variable | Description |
|---|---|
| `GATEWAY_URL` | Gateway base URL (e.g. `http://localhost:8080`) |
| `GATEWAY_TOKEN` | Token for standard API access |
| `GATEWAY_ADMIN_TOKEN` | Token for admin operations (credentials, health) |

These override values from the config file written by `plit init`.

---

## Output modes

`plit` adapts its output to context:

- **TTY** — human-readable, formatted
- **Piped** — JSON automatically
- **`--json`** — force JSON regardless of context

---

## Architecture

`plit` is a thin CLI wrapper around `plit-gw`. Installing `plit` gives you both the command-line interface and the gateway server in a single `cargo install`. The gateway handles protocol adapters, message routing, and backend connections. The CLI handles setup, process management, and user-facing interaction.

For gateway configuration, adapter setup, and backend protocol details, see the [plit-gw repository](https://github.com/theuselessai/plit-gw).

---

## Related

- [plit-gw](https://github.com/theuselessai/plit-gw) — the gateway crate
- [Pipelit](https://github.com/theuselessai/Pipelit) — the agent orchestration platform

---

## License

Apache 2.0. See [LICENSE](LICENSE).