openwork 0.0.1-alpha.0 → 0.1.1-rc.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 LangChain, Inc.
+
+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

@@ -0,0 +1,139 @@
+# openwork
+
+A tactical agent interface for [deepagentsjs](https://github.com/langchain-ai/deepagentsjs) - an opinionated harness for building deep agents with filesystem capabilities, planning, and subagent delegation.
+
+![openwork screenshot](docs/screenshot.png)
+
+## Features
+
+- **Chat Interface** - Stream conversations with your AI agent in real-time
+- **TODO Tracking** - Visual task list showing agent's planning progress
+- **Filesystem Browser** - See files the agent reads, writes, and edits
+- **Subagent Monitoring** - Track spawned subagents and their status
+- **Human-in-the-Loop** - Approve, edit, or reject sensitive tool calls
+- **Multi-Model Support** - Use Claude, GPT-4, Gemini, or local models
+- **Thread Persistence** - SQLite-backed conversation history
+
+## Installation
+
+### npm (recommended)
+
+```bash
+# Run directly
+npx openwork
+
+# Or install globally
+npm install -g openwork
+openwork
+```
+
+Requires Node.js 18+. Electron is installed automatically as a dependency.
+
+### From Source
+
+```bash
+git clone https://github.com/langchain-ai/openwork.git
+cd openwork
+npm install
+npm run dev
+```
+
+## Configuration
+
+### API Keys
+
+openwork supports multiple LLM providers. Set your API keys via:
+
+1. **Environment Variables** (recommended)
+   ```bash
+   export ANTHROPIC_API_KEY="sk-ant-..."
+   export OPENAI_API_KEY="sk-..."
+   export GOOGLE_API_KEY="..."
+   ```
+
+2. **In-App Settings** - Click the settings icon and enter your API keys securely.
+
+### Supported Models
+
+| Provider | Models |
+|----------|--------|
+| Anthropic | Claude Sonnet 4, Claude 3.5 Sonnet, Claude 3.5 Haiku |
+| OpenAI | GPT-4o, GPT-4o Mini |
+| Google | Gemini 2.0 Flash |
+
+## Architecture
+
+openwork is built with:
+
+- **Electron** - Cross-platform desktop framework
+- **React** - UI components with tactical/SCADA-inspired design
+- **deepagentsjs** - Agent harness with planning, filesystem, and subagents
+- **LangGraph** - State machine for agent orchestration
+- **SQLite** - Local persistence for threads and checkpoints
+
+```
+┌─────────────────────────────────────────────────────────────┐
+│                     Electron Main Process                    │
+├─────────────────────────────────────────────────────────────┤
+│  ┌─────────────┐  ┌─────────────┐  ┌─────────────────────┐ │
+│  │ IPC Handlers│  │   SQLite    │  │   DeepAgentsJS      │ │
+│  │  - agent    │  │  - threads  │  │   - createAgent     │ │
+│  │  - threads  │  │  - runs     │  │   - checkpointer    │ │
+│  │  - models   │  │  - assists  │  │   - middleware      │ │
+│  └─────────────┘  └─────────────┘  └─────────────────────┘ │
+└─────────────────────────────────────────────────────────────┘
+                              │
+                         IPC Bridge
+                              │
+┌─────────────────────────────────────────────────────────────┐
+│                    Electron Renderer Process                 │
+├─────────────────────────────────────────────────────────────┤
+│  ┌──────────┐  ┌─────────────────────┐  ┌───────────────┐  │
+│  │ Sidebar  │  │    Chat Interface   │  │  Right Panel  │  │
+│  │ - Threads│  │  - Messages         │  │  - TODOs      │  │
+│  │ - Model  │  │  - Tool Renderers   │  │  - Files      │  │
+│  │ - Config │  │  - Streaming        │  │  - Subagents  │  │
+│  └──────────┘  └─────────────────────┘  └───────────────┘  │
+└─────────────────────────────────────────────────────────────┘
+```
+
+## Development
+
+```bash
+# Install dependencies
+npm install
+
+# Start development server
+npm run dev
+
+# Build for production
+npm run build
+```
+
+## Releases
+
+To publish a new release:
+
+1. Create a git tag: `git tag v0.2.0`
+2. Push the tag: `git push origin v0.2.0`
+3. GitHub Actions will:
+   - Build the application
+   - Publish to npm
+   - Create a GitHub release
+
+## Design System
+
+openwork uses a tactical/SCADA-inspired design system optimized for:
+
+- **Information density** - Dense layouts for monitoring agent activity
+- **Status at a glance** - Color-coded status indicators (nominal, warning, critical)
+- **Dark mode only** - Reduced eye strain for extended sessions
+- **Monospace typography** - JetBrains Mono for data and code
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for development guidelines.
+
+## License
+
+MIT License - see [LICENSE](LICENSE) for details.

package/bin/cli.js

@@ -0,0 +1,63 @@
+#!/usr/bin/env node
+/* eslint-disable @typescript-eslint/no-require-imports */
+/**
+ * openwork CLI - Launches the Electron app
+ */
+
+const { spawn } = require('child_process')
+const path = require('path')
+
+// Set process title for Activity Monitor
+process.title = 'openwork'
+
+const args = process.argv.slice(2)
+
+// Handle --version flag
+if (args.includes('--version') || args.includes('-v')) {
+  const { version } = require('../package.json')
+  console.log(`openwork v${version}`)
+  process.exit(0)
+}
+
+// Handle --help flag
+if (args.includes('--help') || args.includes('-h')) {
+  console.log(`
+openwork - A tactical agent interface for deepagentsjs
+
+Usage:
+  openwork              Launch the application
+  openwork --version    Show version
+  openwork --help       Show this help
+`)
+  process.exit(0)
+}
+
+// Get the path to electron
+const electron = require('electron')
+
+// Launch electron with our main process
+const mainPath = path.join(__dirname, '..', 'out', 'main', 'index.js')
+
+const child = spawn(electron, [mainPath, ...args], {
+  stdio: 'inherit'
+})
+
+// Forward signals to child process
+function forwardSignal(signal) {
+  if (child.pid) {
+    process.kill(child.pid, signal)
+  }
+}
+
+process.on('SIGINT', () => forwardSignal('SIGINT'))
+process.on('SIGTERM', () => forwardSignal('SIGTERM'))
+
+// Exit with the same code as the child
+child.on('close', (code) => {
+  process.exit(code ?? 0)
+})
+
+child.on('error', (err) => {
+  console.error('Failed to start openwork:', err.message)
+  process.exit(1)
+})