Repository navigation
Commit e9b99b0
committed
docs(feishu-bridge): spell out the two-identity setup, the scopes, and the failure modes
The Setup section said "a lark-cli you have already configured" and stopped
there. That is not enough, because the bridge reads and writes through different
identities and a half-configured app fails in a way the log does not make obvious.
The bridge calls `--as user` for +chat-messages-list and
+messages-resources-download, and `--as bot` for +messages-send, +messages-reply
and +messages-edit. A bot cannot see a p2p conversation history, and only a bot
may edit a message it sent, so both identities are genuinely required and they
fail independently. Documented:
- `lark-cli auth status` must show `identities.bot.status` and
`identities.user.status` both `ready`.
- The minimum scope set, split by identity: `im:message:readonly` and
`im:resource` on the user side; `im:message` and `im:message:update` on the bot
side. Called out `offline_access` separately, because without it the user token
stops working after a couple of hours and the bridge goes quiet at a moment when
nothing reports an error.
- That the user identity is the user"s own account, so the bridge acts as them.
- A p2p chat with the app as the simplest arrangement, which is what this Plugin
is built and tested for.
- First-run behaviour: the workspace is created on start and nothing historical
is picked up, so the first message has to come after the bridge starts.
- Obtaining a chat id, including the `--page-all` that the listing needs.
Also added, because an operator hits them immediately and none were documented:
- Running it in the background, with the reason the Plugin ships no autostart and
the specific trap that a supervisor inheriting the child"s std handles blocks
forever. This is the defect that cost the most time during development.
- Uninstall: `--stop`, then delete the data directory. Removing the Plugin leaves
that directory alone on purpose; it is user data.
- Network: outbound HTTPS to the Feishu/Lark Open Platform only, no inbound
listener, and `lark-cli` owns proxy configuration.
- A symptom-to-cause table for the identity, scope, token-expiry, attachment,
paging and lock failures, noting that every one of them writes a log line, so an
empty log plus a silent chat means the watcher is not running.
skills/SKILL.md carries the same identity and scope requirements in its
pre-flight and troubleshooting sections, so the agent checks them before starting
rather than after a user reports silence.
Validation: `node scripts/validate.mjs` green, 84 passed / 0 failed.1 parent 323deb8 commit e9b99b0
3 files changed
Lines changed: 201 additions & 33 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
43 | 43 | | |
44 | 44 | | |
45 | 45 | | |
46 | | - | |
| 46 | + | |
47 | 47 | | |
48 | | - | |
49 | | - | |
| 48 | + | |
| 49 | + | |
50 | 50 | | |
51 | | - | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
52 | 65 | | |
53 | | - | |
54 | | - | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
55 | 72 | | |
56 | | - | |
| 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 | + | |
57 | 109 | | |
58 | 110 | | |
59 | 111 | | |
60 | 112 | | |
61 | 113 | | |
62 | | - | |
| 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 | + | |
63 | 148 | | |
64 | 149 | | |
65 | | - | |
| 150 | + | |
66 | 151 | | |
67 | 152 | | |
68 | | - | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
69 | 157 | | |
70 | | - | |
| 158 | + | |
| 159 | + | |
| 160 | + | |
| 161 | + | |
| 162 | + | |
71 | 163 | | |
72 | 164 | | |
73 | 165 | | |
| |||
225 | 317 | | |
226 | 318 | | |
227 | 319 | | |
| 320 | + | |
| 321 | + | |
| 322 | + | |
| 323 | + | |
| 324 | + | |
| 325 | + | |
| 326 | + | |
| 327 | + | |
| 328 | + | |
| 329 | + | |
| 330 | + | |
| 331 | + | |
| 332 | + | |
| 333 | + | |
| 334 | + | |
| 335 | + | |
228 | 336 | | |
229 | 337 | | |
230 | 338 | | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
28 | 28 | | |
29 | 29 | | |
30 | 30 | | |
31 | | - | |
32 | | - | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
33 | 45 | | |
34 | 46 | | |
35 | 47 | | |
| |||
97 | 109 | | |
98 | 110 | | |
99 | 111 | | |
100 | | - | |
| 112 | + | |
101 | 113 | | |
102 | 114 | | |
103 | | - | |
| 115 | + | |
| 116 | + | |
104 | 117 | | |
105 | | - | |
106 | | - | |
107 | | - | |
108 | | - | |
109 | | - | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
110 | 129 | | |
111 | | - | |
| 130 | + | |
112 | 131 | | |
113 | | - | |
| 132 | + | |
114 | 133 | | |
115 | 134 | | |
116 | 135 | | |
| 136 | + | |
| 137 | + | |
| 138 | + | |
117 | 139 | | |
118 | 140 | | |
119 | 141 | | |
| |||
128 | 150 | | |
129 | 151 | | |
130 | 152 | | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
| 158 | + | |
| 159 | + | |
| 160 | + | |
131 | 161 | | |
132 | 162 | | |
133 | 163 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
28 | 28 | | |
29 | 29 | | |
30 | 30 | | |
31 | | - | |
32 | | - | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
33 | 45 | | |
34 | 46 | | |
35 | 47 | | |
| |||
97 | 109 | | |
98 | 110 | | |
99 | 111 | | |
100 | | - | |
| 112 | + | |
101 | 113 | | |
102 | 114 | | |
103 | | - | |
| 115 | + | |
| 116 | + | |
104 | 117 | | |
105 | | - | |
106 | | - | |
107 | | - | |
108 | | - | |
109 | | - | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
110 | 129 | | |
111 | | - | |
| 130 | + | |
112 | 131 | | |
113 | | - | |
| 132 | + | |
114 | 133 | | |
115 | 134 | | |
116 | 135 | | |
| 136 | + | |
| 137 | + | |
| 138 | + | |
117 | 139 | | |
118 | 140 | | |
119 | 141 | | |
| |||
128 | 150 | | |
129 | 151 | | |
130 | 152 | | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
| 158 | + | |
| 159 | + | |
| 160 | + | |
131 | 161 | | |
132 | 162 | | |
133 | 163 | | |
| |||
0 commit comments