mirror of
https://github.com/different-ai/openwork
synced 2026-05-09 00:32:05 +02:00
75 lines
1.9 KiB
Plaintext
75 lines
1.9 KiB
Plaintext
---
|
|
title: "Quickstart"
|
|
description: "Install OpenWork and run your first worker"
|
|
---
|
|
|
|
## Get started in four steps
|
|
|
|
### Step 1: Install OpenWork
|
|
|
|
<AccordionGroup>
|
|
<Accordion icon="download" title="Desktop app (recommended)">
|
|
Download the latest release from:
|
|
`https://openwork.software/download`
|
|
|
|
Start with macOS if you want the fastest path.
|
|
</Accordion>
|
|
<Accordion icon="terminal" title="CLI host (openwrk)">
|
|
```bash
|
|
npm install -g openwrk
|
|
openwrk start --workspace /path/to/workspace --approval auto
|
|
```
|
|
|
|
This runs OpenCode + OpenWork server + optional router without desktop UI.
|
|
</Accordion>
|
|
</AccordionGroup>
|
|
|
|
### Step 2: Create your first worker
|
|
|
|
<Accordion icon="folder-plus" title="Set up one clean worker">
|
|
Use one worker per business domain.
|
|
|
|
Suggested first worker names:
|
|
- `agency-core`
|
|
- `client-a`
|
|
- `client-b`
|
|
|
|
This keeps context and automations isolated.
|
|
</Accordion>
|
|
|
|
### Step 3: Connect and run one task
|
|
|
|
<Accordion icon="play" title="Run one visible workflow">
|
|
Start with a deterministic workflow:
|
|
- competitor research
|
|
- daily report
|
|
- weekly summary
|
|
|
|
Keep prompts and outputs in one worker first, then scale.
|
|
</Accordion>
|
|
|
|
### Step 4: Share with your team
|
|
|
|
<Accordion icon="share-2" title="Use worker URL + token, or invite link">
|
|
Open worker actions in OpenWork and share:
|
|
- `OpenWork worker URL`
|
|
- `Access token`
|
|
- `OpenWork invite link` (prefills URL + token)
|
|
|
|
The invite link is best for fast teammate onboarding.
|
|
</Accordion>
|
|
|
|
## CLI example
|
|
|
|
```bash
|
|
npm install -g openwrk
|
|
openwrk start --workspace /path/to/workspace --approval auto
|
|
openwrk status --openwork-url http://127.0.0.1:8787 --opencode-url http://127.0.0.1:4096
|
|
```
|
|
|
|
## Next steps
|
|
|
|
- Use `/tutorials/automations-repeatable-jobs` to add reliable recurring outputs.
|
|
- Use `/tutorials/worker-isolation` before onboarding more teammates.
|
|
- Use `/tutorials/share-worker-invite-link` to remove copy/paste friction.
|