mirror of
https://github.com/different-ai/openwork
synced 2026-04-25 17:15:34 +02:00
docs: update documentation based on recent changes (#1294)
This commit is contained in:
11
PRODUCT.md
11
PRODUCT.md
@@ -33,6 +33,17 @@ Where are workflow hosted:
|
|||||||
- Remote via a OpenWork Host (CLI or desktop)
|
- Remote via a OpenWork Host (CLI or desktop)
|
||||||
- Remote on OpenWork Cloud (via Den sandbox workers)
|
- Remote on OpenWork Cloud (via Den sandbox workers)
|
||||||
|
|
||||||
|
## Current OpenWork Cloud flow
|
||||||
|
|
||||||
|
- Users can sign in with the standard web auth providers or accept an org invite through the hosted join flow.
|
||||||
|
- Invite signup keeps the invited email fixed, verifies the user by email code, and then drops them into the org join path.
|
||||||
|
- Cloud workers are a paid flow: users complete checkout before they can launch hosted workers.
|
||||||
|
- After a worker is ready, the user connects from the OpenWork app with `Add a worker` -> `Connect remote`, or opens the generated deep link directly.
|
||||||
|
|
||||||
|
## Team distribution
|
||||||
|
|
||||||
|
- Organizations can publish shared skill hubs so members discover approved skills from one managed place instead of collecting local-only installs by hand.
|
||||||
|
|
||||||
## Actors
|
## Actors
|
||||||
Bob IT guy makes the config.
|
Bob IT guy makes the config.
|
||||||
Susan the accountant consumes the config.
|
Susan the accountant consumes the config.
|
||||||
|
|||||||
@@ -22,7 +22,11 @@ OpenWork is designed around the idea that you can easily ship your agentic workf
|
|||||||
|
|
||||||
## Quick start
|
## Quick start
|
||||||
|
|
||||||
Download the correct version in [here](https://openworklabs.com/download), in the latest [releases](https://github.com/different-ai/openwork/releases) or install from source below.
|
Download the desktop app from [openworklabs.com/download](https://openworklabs.com/download), grab the latest [GitHub release](https://github.com/different-ai/openwork/releases), or install from source below.
|
||||||
|
|
||||||
|
- macOS and Linux downloads are available directly.
|
||||||
|
- Windows access is currently handled through the paid support plan on [openworklabs.com/pricing#windows-support](https://openworklabs.com/pricing#windows-support).
|
||||||
|
- Hosted OpenWork Cloud workers are launched from the web app after checkout, then connected from the desktop app via `Add a worker` -> `Connect remote`.
|
||||||
|
|
||||||
## Why
|
## Why
|
||||||
|
|
||||||
@@ -44,6 +48,7 @@ OpenWork is designed to be:
|
|||||||
- **Execution plan**: render OpenCode todos as a timeline.
|
- **Execution plan**: render OpenCode todos as a timeline.
|
||||||
- **Permissions**: surface permission requests and reply (allow once / always / deny).
|
- **Permissions**: surface permission requests and reply (allow once / always / deny).
|
||||||
- **Templates**: save and re-run common workflows (stored locally).
|
- **Templates**: save and re-run common workflows (stored locally).
|
||||||
|
- **Debug exports**: copy or export the runtime debug report and developer log stream from Settings -> Debug when you need to file a bug.
|
||||||
- **Skills manager**:
|
- **Skills manager**:
|
||||||
- list installed `.opencode/skills` folders
|
- list installed `.opencode/skills` folders
|
||||||
- import a local skill folder into `.opencode/skills/<skill-name>`
|
- import a local skill folder into `.opencode/skills/<skill-name>`
|
||||||
@@ -173,6 +178,8 @@ pnpm test:e2e
|
|||||||
|
|
||||||
## Troubleshooting
|
## Troubleshooting
|
||||||
|
|
||||||
|
If you need to report a desktop or session bug, open Settings -> Debug and export both the runtime debug report and developer logs before filing an issue.
|
||||||
|
|
||||||
### Linux / Wayland (Hyprland)
|
### Linux / Wayland (Hyprland)
|
||||||
|
|
||||||
If OpenWork crashes on launch with WebKitGTK errors like `Failed to create GBM buffer`, disable dmabuf or compositing before launch. Try one of the following environment flags.
|
If OpenWork crashes on launch with WebKitGTK errors like `Failed to create GBM buffer`, disable dmabuf or compositing before launch. Try one of the following environment flags.
|
||||||
|
|||||||
@@ -13,7 +13,10 @@ Use the right channel to get faster help:
|
|||||||
|
|
||||||
- Search existing issues to avoid duplicates.
|
- Search existing issues to avoid duplicates.
|
||||||
- Include exact OpenWork/OpenCode versions, OS, and reproduction steps.
|
- Include exact OpenWork/OpenCode versions, OS, and reproduction steps.
|
||||||
- Add logs/screenshots when possible.
|
- For desktop, worker, or session bugs, open Settings -> Debug and include both:
|
||||||
|
- the runtime debug report
|
||||||
|
- the developer log export
|
||||||
|
- Add screenshots when they help explain the flow or failure state.
|
||||||
|
|
||||||
## Maintainer triage
|
## Maintainer triage
|
||||||
|
|
||||||
|
|||||||
@@ -5,11 +5,20 @@ Frontend for `app.openworklabs.com`.
|
|||||||
## What it does
|
## What it does
|
||||||
|
|
||||||
- Signs up / signs in users against Den service auth.
|
- Signs up / signs in users against Den service auth.
|
||||||
|
- Handles invited-org signup flows where the invited email stays locked and the user verifies access before joining.
|
||||||
- Launches cloud workers via `POST /v1/workers`.
|
- Launches cloud workers via `POST /v1/workers`.
|
||||||
- Handles paywall responses (`402 payment_required`) and shows Polar checkout links.
|
- Handles paywall responses (`402 payment_required`), routes users through Polar checkout, and only enables worker launch after purchase.
|
||||||
|
- Offers desktop handoff actions so users can open the generated worker directly in OpenWork or copy the connect credentials manually.
|
||||||
- Uses a Next.js proxy route (`/api/den/*`) to reach `api.openworklabs.com` without browser CORS issues.
|
- Uses a Next.js proxy route (`/api/den/*`) to reach `api.openworklabs.com` without browser CORS issues.
|
||||||
- Uses a same-origin auth proxy (`/api/auth/*`) so GitHub OAuth callbacks can land on `app.openworklabs.com`.
|
- Uses a same-origin auth proxy (`/api/auth/*`) so GitHub OAuth callbacks can land on `app.openworklabs.com`.
|
||||||
|
|
||||||
|
## Current hosted user flow
|
||||||
|
|
||||||
|
1. Sign in with a standard provider or accept an org invite.
|
||||||
|
2. If the org requires billing, complete checkout before launching a worker.
|
||||||
|
3. Launch the worker from the cloud dashboard.
|
||||||
|
4. Open the worker in the desktop app with the provided deep link, or copy the URL/token into `Connect remote` manually.
|
||||||
|
|
||||||
## Local development
|
## Local development
|
||||||
|
|
||||||
1. Install workspace deps from repo root:
|
1. Install workspace deps from repo root:
|
||||||
|
|||||||
Reference in New Issue
Block a user