Skip to content

Community documentation for OpenWork - The open source AI coworker. Unofficial documentation based on commit 8855d5f31ca0dd485379af1ad241071fe62052a0

Notifications You must be signed in to change notification settings

Evoke4350/openwork-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

OpenWork Documentation

Document Validity

Complete documentation for the OpenWork desktop application - the open source AI coworker that lives on your desktop.

Quick Start

# Install Ruby dependencies
bundle install

# Start local development server
bundle exec jekyll serve

# Open in browser
open http://localhost:4000

What is OpenWork?

OpenWork is a standalone desktop automation assistant built with:

  • Electron - Cross-platform desktop framework
  • React - Modern UI via Vite bundling
  • OpenCode CLI - Multi-provider AI (Anthropic, OpenAI, Google, Groq)
  • Secure Storage - OS keychain integration via keytar
  • Bundled Node.js - v20.18.1 for MCP server compatibility

Documentation Structure

Section Pages Description
Getting Started 4 Installation, configuration, first task
User Guide 6 Daily usage, UI walkthrough, troubleshooting
Architecture 7 System architecture, IPC, security, state management
Skills 3 Skills system, bundled skills, creating skills
Features 6 Single-instance, protocol handler, API keys, permissions
Development 7 Setup, building, testing, debugging, releasing
Reference 3 IPC API, configuration, glossary
Contributing 3 Contribution guide, workflow, code conventions

Local Development

Prerequisites

  • Ruby 3.3+
  • Bundler: gem install bundler

Commands

bundle install              # Install dependencies
bundle exec jekyll serve    # Start dev server
bundle exec jekyll build    # Build site

Deployment

Documentation is deployed via GitHub Pages to: https://evoke4350.github.io/openwork-docs/

License

Documentation is available under the same terms as OpenWork (MIT License).

Disclaimer

This documentation is an independent community resource. It is not affiliated with, endorsed by, or associated with Accomplish Inc or the accomplish-ai/openwork project.


This documentation is valid for commit 8855d5f31ca0dd485379af1ad241071fe62052a0 of the accomplish-ai/openwork repository.

About

Community documentation for OpenWork - The open source AI coworker. Unofficial documentation based on commit 8855d5f31ca0dd485379af1ad241071fe62052a0

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages