afk-code 0.1.0 → 0.1.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Colin Harman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,133 +1,100 @@
 # AFK Code
 
-Monitor your Claude Code sessions from Slack or Discord. Get notified when Claude needs input, and respond without leaving your chat app.
+Monitor and interact with Claude Code sessions from Slack or Discord. Respond from your phone while AFK.
 
-## How it works
-
-1. Run `afk-code slack` or `afk-code discord` to start the bot
-2. Run `afk-code run -- claude` to start a monitored Claude Code session
-3. A new thread (Slack) or channel (Discord) is created for the session
-4. All messages are relayed bidirectionally - respond from your phone while AFK
-
-## Installation
+## Quick Start (Slack)
 
 ```bash
-# Clone the repo
-git clone https://github.com/clharman/afk-code.git
-cd afk-code
-
-# Install dependencies
-bun install
-
-# Link the CLI globally (optional)
-bun link
-```
-
-Requires [Bun](https://bun.sh) runtime.
-
-## Slack Setup
-
-### 1. Create a Slack App
-
-Go to [api.slack.com/apps](https://api.slack.com/apps) and click **Create New App** → **From manifest**.
-
-Paste the contents of `slack-manifest.json` from this repo, then click **Create**.
+# 1. Create a Slack app at https://api.slack.com/apps
+#    Click "Create New App" → "From manifest" → paste slack-manifest.json
 
-### 2. Install to Workspace
+# 2. Install to your workspace and get credentials:
+#    - Bot Token (xoxb-...) from OAuth & Permissions
+#    - App Token (xapp-...) from Basic Information → App-Level Tokens (needs connections:write)
+#    - Your User ID from your Slack profile → "..." → Copy member ID
 
-Click **Install to Workspace** and authorize the app.
+# 3. Configure and run
+npx afk-code slack setup   # Enter your credentials
+npx afk-code slack         # Start the bot
 
-### 3. Get Your Credentials
-
-- **Bot Token**: OAuth & Permissions → Bot User OAuth Token (`xoxb-...`)
-- **App Token**: Basic Information → App-Level Tokens → Generate Token with `connections:write` scope (`xapp-...`)
-- **Signing Secret**: Basic Information → Signing Secret
-- **Your User ID**: In Slack, click your profile → three dots → Copy member ID
-
-### 4. Configure AFK Code
-
-```bash
-afk-code slack setup
+# 4. In another terminal, start a monitored Claude session
+npx afk-code run -- claude
 ```
 
-Follow the prompts to enter your credentials. Config is saved to `~/.afk-code/slack.env`.
+A new channel is created for each session. Messages relay bidirectionally.
 
-### 5. Run
+## Quick Start (Discord)
 
 ```bash
-# Terminal 1: Start the Slack bot
-afk-code slack
-
-# Terminal 2: Start a Claude Code session
-afk-code run -- claude
-```
+# 1. Create a Discord app at https://discord.com/developers/applications
+#    - Go to Bot → Reset Token → copy it
+#    - Enable "Message Content Intent"
+#    - Go to OAuth2 → URL Generator → select "bot" scope
+#    - Select permissions: Send Messages, Manage Channels, Read Message History
+#    - Open the generated URL to invite the bot
 
-A new thread will appear in your Slack channel for each session.
+# 2. Get your User ID (enable Developer Mode, right-click your name → Copy User ID)
 
-## Discord Setup
+# 3. Configure and run
+npx afk-code discord setup   # Enter your credentials
+npx afk-code discord         # Start the bot
 
-### 1. Create a Discord Application
-
-Go to [discord.com/developers/applications](https://discord.com/developers/applications) and click **New Application**.
-
-### 2. Create a Bot
-
-- Go to **Bot** in the sidebar
-- Click **Reset Token** and copy it
-- Enable **Message Content Intent** under Privileged Gateway Intents
+# 4. In another terminal, start a monitored Claude session
+npx afk-code run -- claude
+```
 
-### 3. Invite the Bot
+## Commands
 
-- Go to **OAuth2** → **URL Generator**
-- Select scopes: `bot`
-- Select permissions: `Send Messages`, `Manage Channels`, `Read Message History`
-- Open the generated URL to invite the bot to your server
+```
+afk-code slack setup        Configure Slack credentials
+afk-code slack              Run the Slack bot
+afk-code discord setup      Configure Discord credentials
+afk-code discord            Run the Discord bot
+afk-code run -- <command>   Start a monitored session
+afk-code help               Show help
+```
 
-### 4. Get Your User ID
+### Slack Slash Commands
 
-Enable Developer Mode in Discord settings, then right-click your name → **Copy User ID**.
+- `/afk` - List active sessions
+- `/background` - Send Ctrl+B (background signal)
+- `/interrupt` - Send Escape (interrupt signal)
+- `/mode` - Send Shift+Tab (toggle mode)
+    - Not recommended since you don't get feedback on what mode you're in
 
-### 5. Configure AFK Code
+## Installation Options
 
 ```bash
-afk-code discord setup
-```
-
-Enter your bot token and user ID. Config is saved to `~/.afk-code/discord.env`.
+# Global install
+npm install -g afk-code
 
-### 6. Run
-
-```bash
-# Terminal 1: Start the Discord bot
-afk-code discord
+# Or use npx (no install)
+npx afk-code <command>
 
-# Terminal 2: Start a Claude Code session
-afk-code run -- claude
+# Or run from source
+git clone https://github.com/clharman/afk-code.git
+cd afk-code && npm install
+npm run dev -- slack
+npm run dev -- run -- claude
 ```
 
-An "AFK Code Sessions" category will be created with a channel for each session.
+Requires Node.js 18+.
 
-## Commands
+## How It Works
 
-```
-afk-code run -- <command>   Start a monitored session (e.g., afk-code run -- claude)
-afk-code slack              Run the Slack bot
-afk-code slack setup        Configure Slack credentials
-afk-code discord            Run the Discord bot
-afk-code discord setup      Configure Discord credentials
-afk-code help               Show help
-```
+1. `afk-code slack` or `afk-code discord` starts a bot that listens for sessions
+2. `afk-code run -- claude` spawns Claude in a PTY and connects to the bot via Unix socket
+3. The bot watches Claude's JSONL files for messages and relays them to chat
+4. Messages you send in chat are forwarded to the terminal
 
-## How It Works
+## Limitations
 
-AFK Code watches Claude Code's JSONL output files to capture messages in real-time. When you start a session with `afk-code run`, it:
+- Does not support plan mode or responding to Claude Code's form-based questions (AskUserQuestion)
+- Does not send tool calls or results
 
-1. Spawns the command in a PTY (pseudo-terminal)
-2. Connects to the running Slack/Discord bot via Unix socket
-3. Watches the Claude Code JSONL file for new messages
-4. Relays messages bidirectionally between terminal and chat
+## Disclaimer
 
-Messages you send in Slack/Discord threads are forwarded to the terminal as if you typed them.
+This project is not affiliated with Anthropic. Use at your own risk.
 
 ## License