@z40/magpie 1.0.0 → 1.0.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.
Files changed (3) hide show
  1. package/LICENSE +36 -0
  2. package/README.md +61 -8
  3. package/package.json +1 -1
package/LICENSE ADDED
@@ -0,0 +1,36 @@
1
+ MIT License
2
+
3
+ Copyright (c) cc-connect contributors (upstream: https://github.com/chenhg5/cc-connect)
4
+ Copyright (c) 2026 ChamberZ40 (modifications in this fork)
5
+
6
+ Permission is hereby granted, free of charge, to any person obtaining a copy
7
+ of this software and associated documentation files (the "Software"), to deal
8
+ in the Software without restriction, including without limitation the rights
9
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10
+ copies of the Software, and to permit persons to whom the Software is
11
+ furnished to do so, subject to the following conditions:
12
+
13
+ The above copyright notice and this permission notice shall be included in all
14
+ copies or substantial portions of the Software.
15
+
16
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22
+ SOFTWARE.
23
+
24
+ ---
25
+
26
+ Provenance note
27
+
28
+ This repository is a fork of https://github.com/chenhg5/cc-connect, trimmed to a
29
+ subset of its agents and platforms.
30
+
31
+ Upstream ships no LICENSE file of its own; its MIT grant is declared in
32
+ `npm/package.json` (`"license": "MIT"`). MIT permits redistribution and
33
+ sublicensing provided the copyright and permission notice above is retained,
34
+ which is why this fork is MIT rather than a public-domain dedication — a
35
+ dedication would purport to waive rights in upstream's code that this fork does
36
+ not hold.
package/README.md CHANGED
@@ -7,25 +7,78 @@ the chat.
7
7
  Agents: Claude Code, Codex, Cursor Agent, GitHub Copilot CLI, and any
8
8
  ACP-speaking agent. Platforms: Feishu (Lark), WeChat Work, Weixin.
9
9
 
10
- ## Install
10
+ ## Quick start
11
+
12
+ **First, install the agent CLI you want to drive and log into it.** Magpie
13
+ spawns it as a subprocess and inherits its credentials, so an agent that is
14
+ not logged in fails on the first message. For Claude Code:
15
+
16
+ ```bash
17
+ npm install -g @anthropic-ai/claude-code
18
+ claude # log in, then quit
19
+ ```
20
+
21
+ **1. Install magpie.** This downloads the prebuilt binary for your platform
22
+ from the matching GitHub release:
11
23
 
12
24
  ```bash
13
25
  npm install -g @z40/magpie
14
26
  ```
15
27
 
16
- This downloads the prebuilt binary for your platform from the matching GitHub
17
- release and installs it as `magpie`.
28
+ **2. Create the config.** The first run writes `~/.magpie/config.toml` and
29
+ exits it does not start the bridge yet:
30
+
31
+ ```bash
32
+ magpie
33
+ # Created default config at /Users/you/.magpie/config.toml
34
+ # Please edit this file to add your agent and platform credentials, then run magpie again.
35
+ ```
36
+
37
+ **3. Fill it in.** Open that file and set `work_dir` to the project you want
38
+ the agent to work in — it must already exist. Then add your bot credentials.
39
+ For Feishu you can skip the hand-editing:
40
+
41
+ ```bash
42
+ magpie feishu setup # QR onboarding, or --app to bind an existing bot
43
+ ```
44
+
45
+ For WeChat Work and Weixin, see the setup guides:
46
+ [WeChat Work](https://github.com/ChamberZ40/magpie/blob/main/docs/wecom.md),
47
+ [Weixin](https://github.com/ChamberZ40/magpie/blob/main/docs/weixin.md).
48
+ `magpie config example` prints every option, annotated.
49
+
50
+ **4. Start it.**
51
+
52
+ ```bash
53
+ magpie
54
+ ```
55
+
56
+ Message the bot from your chat app. A reply means the round trip works.
18
57
 
19
- ## Usage
58
+ **5. Keep it running** after you close the terminal:
20
59
 
21
60
  ```bash
22
- magpie # first run creates ~/.magpie/config.toml
23
- magpie --config /path/to/config.toml
61
+ magpie daemon install # installs and starts a launchd/systemd service
62
+ magpie daemon logs -f # follow the logs
24
63
  ```
25
64
 
26
- The first run prints a Web admin URL (`http://localhost:9820`) where you create
27
- a project and paste your bot credentials.
65
+ ### If something does not work
66
+
67
+ ```bash
68
+ magpie doctor # checks the local setup: agent CLI, config, permissions
69
+ magpie config path # where the config actually resolved to
70
+ magpie --help # every command, plus the agents and platforms this build ships
71
+ ```
28
72
 
29
73
  ## Documentation
30
74
 
31
75
  Full documentation: https://github.com/ChamberZ40/magpie
76
+
77
+ ## License and credits
78
+
79
+ [MIT](https://github.com/ChamberZ40/magpie/blob/main/LICENSE).
80
+
81
+ Magpie is a fork of [chenhg5/cc-connect](https://github.com/chenhg5/cc-connect),
82
+ which declares MIT in its `npm/package.json`. Most of the code is upstream's;
83
+ this fork trims it to the agents and platforms listed above and no longer
84
+ tracks upstream. It is not affiliated with or endorsed by the upstream project.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@z40/magpie",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "description": "Bridge local AI coding agents (Claude Code, Codex, Cursor, GitHub Copilot, any ACP agent) to messaging platforms (Feishu/Lark, WeChat Work, Weixin)",
5
5
  "keywords": [
6
6
  "claude-code",