tabclaw 0.1.0

package/README.md

@@ -0,0 +1,113 @@
+# Tabclaw
+
+Tabclaw is a local gateway for AI assistant event hooks and notification channels. It helps connect hook-enabled agents to channels like Telegram while keeping runtime state under `~/.tabclaw`.
+
+## What it does
+
+- Runs a local gateway daemon for hook-based agent integrations
+- Attaches supported agents such as `claude` to the gateway
+- Routes session events, permission requests, and status updates to configured channels
+- Provides CLI commands for daemon control, status, logs, and agent attachment
+
+## Installation
+
+```bash
+npm install -g tabclaw
+```
+
+Or run without installing:
+
+```bash
+npx tabclaw init
+```
+
+## Quick start
+
+1. Initialize configuration:
+
+```bash
+tabclaw init
+```
+
+2. Start the gateway daemon:
+
+```bash
+tabclaw gateway start
+```
+
+3. Attach an agent:
+
+```bash
+tabclaw attach claude
+```
+
+4. Check gateway status:
+
+```bash
+tabclaw gateway status
+```
+
+## Main commands
+
+- `tabclaw init` — initialize or update `~/.tabclaw/config.toml`
+- `tabclaw gateway start` — start or restart the gateway daemon
+- `tabclaw gateway stop` — stop the gateway daemon
+- `tabclaw gateway restart` — restart the gateway daemon
+- `tabclaw gateway status` — show gateway health and active sessions
+- `tabclaw attach <agent-type>` — attach a supported agent to the gateway
+- `tabclaw status` — view CLI status
+- `tabclaw logs` — inspect logs
+- `tabclaw stop` — stop the daemon
+
+## Configuration
+
+Copy `config.example.toml` to `~/.tabclaw/config.toml` and fill in your values.
+
+Example:
+
+```toml
+[general]
+default_agent = "claude"
+log_level = "info"
+hook_server_port = 9876
+
+[channel.telegram]
+enabled = true
+bot_token = "YOUR_BOT_TOKEN"
+allowed_users = [123456789]
+
+[agent.claude]
+adapter = "hooks"
+binary = "claude"
+work_dir = ""
+model = ""
+permission_mode = ""
+```
+
+## Development
+
+```bash
+npm install
+npm run dev -- init
+npm test
+npm run build
+```
+
+## Supported platforms
+
+- CLI agent support: `claude`
+- Chat channel support: `Telegram`
+
+## Future plan
+
+- Add more agent adapters beyond Claude Code
+- Support more chat and notification channels
+- Improve permission and session event delivery
+- Make gateway setup and channel configuration more flexible
+
+## Notes
+
+- Use `config.example.toml` as the starting point.
+- Runtime files are stored in `~/.tabclaw`.
+
+MIT

package/config.example.toml

@@ -0,0 +1,29 @@
+# tabclaw configuration
+# Copy to ~/.tabclaw/config.toml and fill in your credentials
+
+[general]
+default_agent = "claude"
+log_level = "info"
+hook_server_port = 9876
+
+[channel.telegram]
+enabled = true
+bot_token = "YOUR_BOT_TOKEN"
+allowed_users = [123456789]
+
+[channel.feishu]
+enabled = false
+app_id = ""
+app_secret = ""
+
+[agent.claude]
+adapter = "hooks"
+binary = "claude"
+work_dir = ""
+model = ""
+permission_mode = ""
+
+  # Agent-specific permission settings
+  [agent.claude.permission]
+  # Low-risk tools that won't trigger permission prompts
+  lowRiskTools = ["Read", "Glob", "Grep", "List", "WebSearch", "codesearch"]

package/dist/cli/index.d.ts

@@ -0,0 +1,2 @@
+
+export {  }