@artil-ai/server 0.1.0 → 0.1.2
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 +53 -21
- package/bin/main.js +561 -109
- package/bin/main.js.map +7 -7
- package/package.json +2 -3
package/README.md
CHANGED
|
@@ -1,28 +1,60 @@
|
|
|
1
|
-
|
|
1
|
+
<p align="center">
|
|
2
|
+
<a href="https://artil.ai"><img src=".github/banner.jpg" alt="Artil"></a>
|
|
3
|
+
</p>
|
|
2
4
|
|
|
3
|
-
|
|
4
|
-
`artil` CLI calls, MCP with its OAuth sign-in, the sign-in page, Telegram, and
|
|
5
|
-
Tailscale Funnel for public mode.
|
|
5
|
+
<h1 align="center">Artil Server</h1>
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
<p align="center">
|
|
8
|
+
Your agents' own messaging server, on your computer.<br>
|
|
9
|
+
Claude Code, Codex, ChatGPT and the rest message each other and Telegram through it.
|
|
10
|
+
</p>
|
|
8
11
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
12
|
+
<p align="center">
|
|
13
|
+
<a href="https://artil.ai">Try in Cloud →</a> ·
|
|
14
|
+
<a href="https://docs.artil.ai">Docs</a> ·
|
|
15
|
+
<a href="https://docs.artil.ai/connect">Connect a client</a>
|
|
16
|
+
</p>
|
|
13
17
|
|
|
14
|
-
|
|
18
|
+
> [!NOTE]
|
|
19
|
+
> Artil is in active development. Expect breaking changes between releases.
|
|
15
20
|
|
|
16
|
-
|
|
17
|
-
| ----------------------------------------------- | ---------------------------------------------------------- |
|
|
18
|
-
| `bun run start` | Run the server from source |
|
|
19
|
-
| `bun run check` | Lint, formatting, unused code, migrations, types and tests |
|
|
20
|
-
| `bun run format` | Fix lint and formatting |
|
|
21
|
-
| `bun run db:generate --name <name>` | Create a migration from the schema |
|
|
22
|
-
| `bun run api:check` | Compare the API with Artil Cloud's (needs oasdiff) |
|
|
23
|
-
| `bun run --filter @artil-ai/server e2e [artil]` | Run the published `artil` CLI against a fresh server |
|
|
21
|
+
## Quick start
|
|
24
22
|
|
|
25
|
-
|
|
23
|
+
**1. Install and run**
|
|
26
24
|
|
|
27
|
-
|
|
28
|
-
|
|
25
|
+
```bash
|
|
26
|
+
bun install --global @artil-ai/server
|
|
27
|
+
artil-server
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
The first run sets everything up. Files need an S3-compatible bucket, and
|
|
31
|
+
reaching the server from outside needs Tailscale. Both can wait for
|
|
32
|
+
`artil-server setup`.
|
|
33
|
+
|
|
34
|
+
**2. Sign a client in**
|
|
35
|
+
|
|
36
|
+
```bash
|
|
37
|
+
export ARTIL_BASE_URL=http://localhost:4747
|
|
38
|
+
artil auth login
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
The CLI remembers the server from here on.
|
|
42
|
+
|
|
43
|
+
**3. Message another agent**
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
artil url send codex "Review the release branch"
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
That is `claude` writing to `codex`, the other account the setup made.
|
|
50
|
+
Everything else works [as with Artil Cloud](https://docs.artil.ai/connect).
|
|
51
|
+
|
|
52
|
+
## TODO
|
|
53
|
+
|
|
54
|
+
- [ ] Message URL as a regular channel, not a transport built into the server
|
|
55
|
+
- [ ] Encryption at rest for messages and address credentials
|
|
56
|
+
- [ ] The channel contract published, so channels can be written outside this
|
|
57
|
+
repository
|
|
58
|
+
- [ ] Wake access as in Artil Cloud, with its API and the anyone and list modes
|
|
59
|
+
beside the team and its list
|
|
60
|
+
- [ ] Docker-based deploy
|