custie 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.
- package/README.md +18 -10
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,10 +1,11 @@
|
|
|
1
|
+
# Custie
|
|
2
|
+
|
|
3
|
+
**Claude Code, inside your Slack.** Your team gets an AI that can read your codebase, edit files, run commands, and use every Claude Code skill -- all from a Slack thread.
|
|
4
|
+
|
|
1
5
|
<p align="center">
|
|
2
6
|
<img src="custie.png" alt="Custie" width="240" />
|
|
3
7
|
</p>
|
|
4
8
|
|
|
5
|
-
# Custie
|
|
6
|
-
|
|
7
|
-
**Claude Code, inside your Slack.** Your team gets an AI that can read your codebase, edit files, run commands, and use every Claude Code skill -- all from a Slack thread.
|
|
8
9
|
|
|
9
10
|
## Why Custie?
|
|
10
11
|
|
|
@@ -25,15 +26,22 @@ Sessions persist across messages. Start a conversation in a thread, come back ho
|
|
|
25
26
|
|
|
26
27
|
Custie runs on your machine (or server) and connects to Slack via **Socket Mode** -- no webhooks, no tunnels, no public URLs. When someone mentions the bot, it spawns a real Claude Code process with full access to your project.
|
|
27
28
|
|
|
28
|
-
|
|
29
|
-
@custie in Slack
|
|
30
|
-
|
|
29
|
+
<p align="center">
|
|
30
|
+
<img src="flow.svg" alt="@custie in Slack → Custie Server → Claude Code CLI → Your Codebase" width="720" />
|
|
31
|
+
</p>
|
|
31
32
|
|
|
32
33
|
## Get Started
|
|
33
34
|
|
|
35
|
+
First, install [Claude Code](https://docs.anthropic.com/en/docs/claude-code) if you haven't already:
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
npm install -g @anthropic-ai/claude-code
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
Then install and run Custie:
|
|
42
|
+
|
|
34
43
|
```bash
|
|
35
|
-
npm install -g
|
|
36
|
-
npm install -g custie # install custie
|
|
44
|
+
npm install -g custie
|
|
37
45
|
custie setup # configure Slack app + tokens
|
|
38
46
|
custie start # run the bot
|
|
39
47
|
```
|
|
@@ -60,8 +68,8 @@ custie config --edit
|
|
|
60
68
|
|
|
61
69
|
| Command | What it does |
|
|
62
70
|
|---|---|
|
|
63
|
-
| `custie setup` |
|
|
64
|
-
| `custie setup --
|
|
71
|
+
| `custie setup` | Guided setup (paste tokens yourself) |
|
|
72
|
+
| `custie setup --browser` | Automated setup via Playwright (requires playwright) |
|
|
65
73
|
| `custie start` | Run the bot (foreground) |
|
|
66
74
|
| `custie install` | Install as background service |
|
|
67
75
|
| `custie uninstall` | Remove background service |
|