WorkCow

English | 简体中文

WorkCow is a desktop app for getting real work done faster with AI. It keeps task context, chat, memory, approvals, and local tools in one place.

Highlights

• Task-oriented desktop workflow instead of a single chat window
• Editable long-term memory stored on the local machine
• Explicit permission confirmation for sensitive tool actions
• BYOK support with built-in and custom AI providers

Quick Start

Requirements

• Node.js LTS
• pnpm@10
• macOS, Windows, or Linux

Install and Run

pnpm install
pnpm dev

Common Commands

Command	Purpose
pnpm dev	Start Vite and the Electron app for local development
pnpm test -- <path-or-pattern>	Run the smallest relevant test scope
pnpm lint	Run ESLint
pnpm build	Build the renderer and Electron processes
pnpm start	Launch the production build locally
pnpm test:e2e	Run Playwright end-to-end coverage
pnpm package	Create Electron distributables

Docs

• Documentation index
• Renderer overview
• Electron overview
• Builtin assets
• Contributing guide

Root Directory

Architecture: src/ contains the React renderer and user-facing UI flows. Architecture: electron/ contains the desktop runtime, IPC bridge, and local modules. Architecture: docs/, scripts/, and root config files cover docs, automation, and project setup.

Name	Role	Purpose
.claude	Config	Claude-related local configuration
.codex	Config	Codex workflows and skills
.env.example	Config	Example environment variables
.eslintignore	Config	ESLint ignore rules
.gitattributes	Config	Git attribute settings
.github	Collaboration	GitHub templates, docs, and workflows
.gitignore	Config	Git ignore rules
AGENTS.md	Policy	Agent workflow and documentation rules
CLAUDE.md	Notes	Claude-side repository notes
CODE_OF_CONDUCT.md	Governance	Community conduct policy
CONTRIBUTING.md	Governance	Contribution and PR process
LICENSE	Governance	MIT license
README.md	Entry	Default English repository overview
README.zh-CN.md	Entry	Simplified Chinese repository overview
SECURITY.md	Governance	Security disclosure policy
build	Assets	Build and signing resources
builtin	Assets	Built-in skills and bundled runtime assets
docs	Docs	Product, release, and support documents
e2e	Tests	Playwright end-to-end tests
electron	Runtime	Electron main process and desktop modules
electron-builder.env	Config	Electron Builder environment file
eslint.config.js	Config	ESLint configuration
index.html	Entry	Vite HTML entry for the renderer
package.json	Manifest	Scripts, dependencies, and package metadata
performance-report.md	Docs	Performance analysis notes
performance-test.md	Docs	Performance testing notes
playwright.config.ts	Config	Playwright configuration
pnpm-lock.yaml	Lockfile	Locked dependency graph
pnpm-workspace.yaml	Config	pnpm workspace settings
postcss.config.js	Config	PostCSS configuration
public	Assets	Static assets and icons
scripts	Tools	Build, release, and helper scripts
src	Frontend	React renderer source code
tailwind.config.js	Config	Tailwind configuration
test-raw-json.mjs	Tools	Raw JSON test helper
tsconfig.app.json	Config	Renderer TypeScript config
tsconfig.json	Config	Root TypeScript config
tsconfig.node.json	Config	Node and Electron TypeScript config
vite.config.ts	Config	Vite configuration
vitest.config.ts	Config	Vitest configuration