@quantiya/codevibe-codex-plugin 1.0.6 → 1.0.8

package/README.md

@@ -1,155 +1,108 @@
-# CodeVibe Codex Plugin
+# CodeVibe for OpenAI Codex CLI
 
-Mobile companion plugin for OpenAI Codex CLI. Monitor and interact with your Codex sessions from your phone.
+**Control OpenAI Codex CLI from your iPhone and Android.** See your agent's work, approve file edits, dictate prompts by voice — all from your phone, anywhere you are.
 
-## Overview
+🌐 **[quantiya.ai/codevibe](https://quantiya.ai/codevibe)** — landing page, demo video, and one-liner installer
 
-This plugin enables bidirectional synchronization between Codex CLI on your Mac and the CodeVibe iOS app. See your conversations, shell commands, file edits, and agent reasoning in real-time on your phone.
+📱 **[Download on the App Store](https://apps.apple.com/app/id6756500217)** · **[Get it on Google Play](https://play.google.com/store/apps/details?id=ai.quantiya.app.codevibe)**
 
-**Part of the CodeVibe multi-agent ecosystem:**
-- [Claude Plugin](https://github.com/hendryyeh/quantiya-codevibe-claude-plugin) - For Claude Code
-- [Gemini Plugin](https://github.com/hendryyeh/quantiya-codevibe-gemini-plugin) - For Gemini CLI
-- **Codex Plugin** (this repo) - For OpenAI Codex CLI
-
-## Quick Start
-
-```bash
-npm install -g @quantiya/codevibe-codex-plugin
-codevibe-codex login   # authenticate with CodeVibe backend
-codevibe-codex         # start Codex with mobile sync
-```
-
-## Features
-
-| Feature | Supported |
-|---------|-----------|
-| User prompts | Yes |
-| Assistant responses | Yes |
-| Agent reasoning/thinking | Yes |
-| Shell commands | Yes |
-| File edits (patches) | Yes |
-| Tool outputs | Yes |
-| Image attachments | Yes |
-| Approval prompts | Yes (via tmux pane detection) |
-| File diff preview | Yes |
-
-### What gets synced
-
-- **Desktop → Mobile:** user prompts, assistant responses, shell commands, tool/file edits, approval prompts, images, logs
-- **Mobile → Desktop:** text prompts and approval responses sent from iOS app into the active Codex session (via tmux)
+---
 
-## Prerequisites
+## Why CodeVibe for Codex CLI
 
-- macOS
-- Node.js 18+
-- tmux (`brew install tmux`)
-- [Codex CLI](https://github.com/openai/codex) installed and authenticated
-- CodeVibe iOS app
+- **🚀 Real-time sync** — every prompt, response, shell command, and file patch shows up on your phone in 100–500ms
+- **✅ Approve from anywhere** — review full file diffs and approve or reject file edits from your phone
+- **🧠 Reasoning visibility** — see Codex's thinking/reasoning alongside its output
+- **🎙️ Voice prompts** — dictate your next prompt with speech-to-text
+- **📷 Image attachments** — send screenshots and photos; downloaded locally for Codex to reference
+- **🔔 Push notifications** — get notified when your agent needs input
+- **🔒 End-to-end encrypted** — AES-256-GCM with ECDH key exchange
+- **🔓 Locked screen support** — works even when your computer screen is locked (via tmux)
+- **🧠 Multi-agent ready** — Codex sessions appear alongside Claude and Gemini sessions in the same app
 
-## Installation
+## Install in 30 seconds
 
 ```bash
-npm install -g @quantiya/codevibe-codex-plugin
+curl -fsSL https://quantiya.ai/codevibe/install.sh | bash
 ```
 
-### From Source (Development)
+Download the **[iOS app](https://apps.apple.com/app/id6756500217)** or **[Android app](https://play.google.com/store/apps/details?id=ai.quantiya.app.codevibe)**, sign in with the same Apple or Google account, and run:
 
 ```bash
-git clone https://github.com/hendryyeh/quantiya-codevibe-codex-plugin.git
-cd codevibe-codex-plugin
-npm install
-npm run build
+codevibe-codex
 ```
 
-## Usage
+Your session appears on your phone automatically.
 
-Use `codevibe-codex` instead of `codex` to enable mobile sync:
+### Manual install
 
 ```bash
-# Start Codex with mobile sync
+npm install -g @quantiya/codevibe
+codevibe login
 codevibe-codex
-
-# Start with an initial prompt
-codevibe-codex "fix the bug in auth.ts"
 ```
 
-### CLI Commands
-
-```bash
-codevibe-codex login   # Authenticate with CodeVibe backend
-codevibe-codex status  # Check authentication status
-codevibe-codex logout  # Sign out
-codevibe-codex         # Start Codex with mobile sync
-```
+## Requirements
 
-## How It Works
+- **macOS, Linux, or WSL Ubuntu** — Windows without WSL is not supported
+- **Node.js** 18.0.0+
+- **tmux** — `brew install tmux` on macOS, `apt install tmux` on Linux/WSL
+- **Codex CLI** installed and authenticated
 
-1. **Session Log Watching** - Monitors `~/.codex/sessions/` for JSONL log files
-2. **Real-time Sync** - Parses log entries and syncs to AWS AppSync backend
-3. **Mobile Display** - iOS app receives events via WebSocket subscription
-4. **Mobile Input** - Messages from iOS are sent to terminal via tmux
+## How it works
 
-Each live Codex process appears as its own CodeVibe session, even if multiple Codex sessions are running in the same project directory.
+Codex CLI writes session logs to `~/.codex/sessions/` as JSONL files. CodeVibe watches those files with chokidar, parses every log entry, and streams it through E2E-encrypted AWS AppSync to your phone.
 
-### Data Flow
+Approval prompts (Codex's interactive Y/N confirmations) aren't in the JSONL log, so CodeVibe observes the live tmux pane to detect them — you get real prompts with real options, and your mobile approve/reject is sent back via `tmux send-keys`.
 
-```
-Desktop → Mobile:
-Codex CLI → Session JSONL → Plugin → AppSync → iOS App
+Each live Codex process appears as its own session on your phone, so you can run multiple concurrent Codex sessions side-by-side with Claude and Gemini.
 
-Mobile → Desktop:
-iOS App → AppSync → Plugin → tmux send-keys → Codex CLI
-```
+## What gets synced
 
-## Configuration
+| Direction | What |
+|---|---|
+| **Desktop → Mobile** | User prompts, assistant responses, agent reasoning, shell commands, file edits (apply_patch), tool outputs, approval prompts, images |
+| **Mobile → Desktop** | Text prompts and approval responses executed via tmux |
 
-Create a `.env.development` file (see `.env.example`):
+## CLI commands
 
 ```bash
-# AWS AppSync
-APPSYNC_URL=https://xxx.appsync-api.us-east-1.amazonaws.com/graphql
-APPSYNC_REALTIME_URL=wss://xxx.appsync-realtime-api.us-east-1.amazonaws.com/graphql
-
-# Cognito
-COGNITO_USER_POOL_ID=us-east-1_xxx
-COGNITO_CLIENT_ID=xxx
-COGNITO_DOMAIN=xxx.auth.us-east-1.amazoncognito.com
+codevibe-codex              # Start Codex with mobile sync
+codevibe-codex "fix bug"    # Start with an initial prompt
+codevibe-codex login        # Authenticate via browser OAuth
+codevibe-codex status       # Check auth status
+codevibe-codex logout       # Sign out
 ```
 
 ## Troubleshooting
 
-### Session not appearing in iOS app
-
 ```bash
-# Check if session logs exist
-ls -la ~/.codex/sessions/$(date +%Y)/$(date +%m)/$(date +%d)/
-
-# Check plugin logs
+# Check server logs
 tail -f /tmp/codevibe-codex-mcp.log
-```
 
-### Mobile prompts not working
+# Verify session logs exist
+ls -la ~/.codex/sessions/$(date +%Y)/$(date +%m)/$(date +%d)/
 
-```bash
-# Verify tmux session exists
+# Verify tmux session
 tmux list-sessions | grep codevibe-codex
+
+# Reinstall if needed
+codevibe update
 ```
 
-## Known Limitations
+## Support
 
-- **Approval prompts are not in JSONL logs** - Detected via tmux pane observation instead of structured log entries
-- Requires tmux for terminal integration (macOS, Linux)
+- **Email:** support@quantiya.ai
+- **Landing page:** [quantiya.ai/codevibe](https://quantiya.ai/codevibe)
+- **Privacy policy:** [quantiya.ai/privacy](https://quantiya.ai/privacy)
 
-## Related
+## Part of the CodeVibe family
 
-- **CodeVibe iOS App** - Available on the App Store
-- [Claude Plugin](https://github.com/hendryyeh/codevibe-claude-plugin) - For Claude Code
-- [Gemini Plugin](https://github.com/hendryyeh/codevibe-gemini-plugin) - For Gemini CLI
+- **[@quantiya/codevibe](https://www.npmjs.com/package/@quantiya/codevibe)** — meta-package (install this, not this plugin directly)
+- **[@quantiya/codevibe-core](https://www.npmjs.com/package/@quantiya/codevibe-core)** — shared library used by all plugins
+- **[@quantiya/codevibe-claude-plugin](https://www.npmjs.com/package/@quantiya/codevibe-claude-plugin)** — Claude Code support
+- **[@quantiya/codevibe-gemini-plugin](https://www.npmjs.com/package/@quantiya/codevibe-gemini-plugin)** — Gemini CLI support
 
 ## License
 
 MIT
-
----
-
-**Maintained by:** CodeVibe Team