Files
openwork/packages/docs/get-started.mdx
Jan Carbonell e1ccd5e976 docs: add OpenWork Cloud setup guides (#1399)
* docs: enhance cloud documentation with new guides and updates

- Updated the Slack integration documentation for clarity and consistency.
- Added new guides for managing members and RBAC, deploying shared workspaces, and creating skill hubs in OpenWork Cloud.
- Introduced instructions for adding custom and managed LLM providers.
- Updated the get-started guide to reflect changes in the Cloud integration process.
- Removed outdated references and improved overall documentation structure.

* get started cloud
2026-04-08 12:53:05 -07:00

52 lines
1.6 KiB
Plaintext

---
title: "Get Started"
description: "OpenWork is the open source alternative to Claude Cowork. "
---
Most users use our [desktop app](https://openworklabs.com). This guide helps you setup OpenWork via the CLI so that you can run OpenWork tasks in the background on your infra.
If you want OpenWork-hosted shared workspaces, org-managed skill hubs, or shared providers for a team, use the [Cloud docs](/get-started-cloud) instead of self-hosting this flow. If you're an enterprise looking to self-host, please [book a call here](https://cal.com/team/openwork/enterprise)
## Step 1: Install on your remote server
Install the npm package:
```bash
npm install -g openwork-orchestrator
```
## Step 2: Start OpenWork in your workspace
Run OpenWork where your code lives:
```bash
openwork start --workspace /path/to/your/workspace --approval auto
```
<Frame>
![OpenWork CLI terminal output showing URL and owner token](/images/get-started-cli-output.png)
</Frame>
Copy:
- `OpenWork URL`
- `OpenWork Owner Token`
## Step 3: Connect the OpenWork desktop app
On your local machine, open the OpenWork desktop app and connect into a remote workspace with:
- On the bottom left click `+ Add workspace`
- Then click `+ Connect Remote workspace`
- Type in the `OpenWork URL and OpenWork Owner Token` from earlier
<Frame>
![Add Remote Workspace dialog in OpenWork desktop app](/images/get-started-add-remote-workspace.png)
</Frame>
## What this gives you right away
- Your code and services stay on the remote machine.
- Your local machine stays light.
- You get a fast path from install to a connected remote OpenWork workspace.