@ycodium-ai/plugin-im 0.2.0
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 +62 -0
- package/dist/index.js +127557 -0
- package/package.json +51 -0
package/README.md
ADDED
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
# @ycodium-ai/plugin-im
|
|
2
|
+
|
|
3
|
+
Talk to your agents from Telegram, WeCom, or Lark. Mention the bot in a group
|
|
4
|
+
and it starts a turn on this machine; the conclusion comes back to the group,
|
|
5
|
+
and anything the agent needs approved lands there too.
|
|
6
|
+
|
|
7
|
+
## What it does
|
|
8
|
+
|
|
9
|
+
Each settings-card row is one group:
|
|
10
|
+
|
|
11
|
+
- Pick a project and that group can start work there, and only hears that project.
|
|
12
|
+
- Leave the project empty and the row only reports, on every project.
|
|
13
|
+
- Secrets (bot tokens, app credentials) stay in the environment secret store.
|
|
14
|
+
The patch file keeps a reference, not the value.
|
|
15
|
+
- Who may command the bot is an allow-list of that platform's user ids. Empty
|
|
16
|
+
means anyone in the group can make the agent run things on this machine.
|
|
17
|
+
- A row can pick its own proxy. On a given machine one platform may be
|
|
18
|
+
unreachable while another is fine.
|
|
19
|
+
|
|
20
|
+
Platforms are adapters behind one plugin, not three plugins. Lark uses the
|
|
21
|
+
vendor SDK for its long connection; WeCom speaks JSON over a WebSocket; Telegram
|
|
22
|
+
is HTTP long-polling.
|
|
23
|
+
|
|
24
|
+
The default is one message per finished turn. A single turn can produce dozens
|
|
25
|
+
of assistant messages, mostly commentary between tool calls.
|
|
26
|
+
|
|
27
|
+
## Requirements
|
|
28
|
+
|
|
29
|
+
A Ycodium server. The plugin asks to dispatch `thread.create`,
|
|
30
|
+
`thread.turn.start`, `thread.turn.interrupt`, and `thread.approval.respond`.
|
|
31
|
+
Those commands only land on threads this plugin started.
|
|
32
|
+
|
|
33
|
+
## Install
|
|
34
|
+
|
|
35
|
+
```
|
|
36
|
+
ycodium plugin add @ycodium-ai/plugin-im
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
The plugin ships enabled with Ycodium as `core.im`. Disabling it closes every
|
|
40
|
+
chat connection. Uninstalling it writes a removal onto the home patch, so a
|
|
41
|
+
restart or upgrade does not bring it back. Reinstalling the unversioned bundled
|
|
42
|
+
package restores the same entry without an npm fetch. Group configuration and
|
|
43
|
+
secrets stay until you clear them.
|
|
44
|
+
|
|
45
|
+
## Surfaces
|
|
46
|
+
|
|
47
|
+
- **Web / Desktop** — Settings → Plugins → Chat. The groups table is the
|
|
48
|
+
settings card this package registers.
|
|
49
|
+
- **Mobile** — the same settings card, without platform option icons (mobile
|
|
50
|
+
has no plugin icon pipeline).
|
|
51
|
+
- Chat replies themselves go to Telegram, WeCom, or Lark, not into a Ycodium
|
|
52
|
+
page.
|
|
53
|
+
|
|
54
|
+
## Developing
|
|
55
|
+
|
|
56
|
+
The package builds its own code and the Lark SDK into `dist/index.js`. The host
|
|
57
|
+
supplies the shared `@ycodium-ai/plugin-api` at runtime. The plugin requires
|
|
58
|
+
plugin API version 2.
|
|
59
|
+
|
|
60
|
+
## License
|
|
61
|
+
|
|
62
|
+
UNLICENSED.
|