WORK-X Docs
Everything you need — from first login to AI-assisted requirements, real-time collaboration, workflow automation, and full audit logging.
Feature Overview
What is WORK-X?
WORK-X is an AI-native project and team management platform for software product teams. It combines:
- Structured requirements & tasks with real-time collaborative editing (Tiptap + Yjs)
- Granular RBAC at org and project level — Owner, Admin, Member, and custom roles
- BYOK AI — bring your own OpenAI, Anthropic, or Gemini keys; stored encrypted
- Visual workflow automation with a ReactFlow node editor
- Full audit logging with GitHub-style heatmaps and per-user activity timelines
- MCP integration for connecting external AI agents (Claude Desktop, etc.)
Sign in
Go to the login page
Visit /login. Sign in with Google OAuth.
Authenticate with Google
Click Continue with Google. After approval you are redirected to your org, or prompted to create one.
Session tokens
WORK-X issues a short-lived JWT access token and a rotatable refresh token, stored as HttpOnly cookies (hq_access / hq_refresh).
Create an organization
An organization is your team workspace. All projects, members, settings, and billing live inside an org.
Open the New Org wizard
Click + New org in the sidebar. A multi-step wizard walks you through: name → database type → storage → AI provider → member invite.
Choose a database type
Three options: Platform Shared (quickest), BYODB (connect your own Postgres), or Dedicated Managed (plan-gated).
Invite founding members
The wizard lets you send email invites immediately, or skip and do it later from Settings → Members.
Create a project
Click + New project
Inside your org, go to Projects and click + New project. Give it a name, key (e.g. SHIP), icon, and description.
Choose a view
Each project has two task views: Kanban (drag-and-drop columns) and List (flat sortable list).
Explore project tabs
Projects have tabs: Overview · Tasks · Requirements · Knowledge · Members · Settings. Each tab is permission-gated via RBAC.
Invite team members
Go to Settings → Members & Invites
In your org sidebar, click Settings, then the Members & Invites tab.
Invite by email
Click Invite User. Enter their email and assign an org-level role. They'll receive an email invite link.
Project-level access
Inside a project, go to the Members tab to add members and assign a project-specific role that overrides their org role.
Task Management
Tasks are the atomic unit of work. Each task can have a rich-text document body, comments, assignees, due date, and priority.
Create a task
In the List or Kanban tab, click + New Task. Set a title, status (TODO / IN_PROGRESS / DONE), and assignee.
Add a document body
Open a task and click the document tab. A full Tiptap editor lets you add rich content — the same editor used for requirements.
Comments & filters
Thread comments directly on a task. Filter the task list by status, assignee, project, or date from the filter bar.
Requirements Management
Requirements are structured specifications with a full lifecycle: Draft → Review → Approved → Released.
Create a requirement
In the Requirements tab, click + Create Requirement. It opens as a full collaborative document.
Add structure
Add: Acceptance Criteria, Comments, Attachments (files/images via org storage), a Decision Log, and linked Research docs.
Version and release
Click Release to create an immutable snapshot. Compare any two versions side-by-side in the full-screen diff modal.
Collaborative Editor
Requirement and task editors use Tiptap + Yjs (CRDTs) for real-time multi-user collaboration.
Multiple editors, one document
When multiple users open the same document, their cursors and text selections appear in real-time with unique colours shown in the presence bar.
Inline AI
Type /// anywhere in the editor to open the AI inline toolbar. Presets: Improve prose, Summarise, Generate acceptance criteria, Translate.
Mermaid diagrams
Insert a Mermaid diagram block from the editor toolbar. Diagrams are syntax-validated and rendered live inside the document.
Roles & Permissions (RBAC)
WORK-X uses a two-tier RBAC system — org-level roles with optional project-level overrides.
OwnerFull control over the org, billing, and all resources. Cannot be removed.
AdminCan manage members, roles, projects, and all settings.
MemberCan view and edit projects they're added to. Default for new invites.
Custom rolesCreate roles with fine-grained permission sets in Settings → Roles & Permissions.
Project-level roles override org-level roles. Go to Settings → Roles & Permissions to see all 50+ permission keys.
AI Key Setup (BYOK)
WORK-X supports Bring Your Own Key — your LLM keys are stored encrypted (AES-256-GCM) and never returned in plaintext.
Go to Settings → AI Provider
Find the AI Provider Keys (BYOK) section. Click + Add Provider Key.
Choose provider and paste key
Select your provider (OpenAI, Anthropic, Google Gemini), paste your API key, and save.
Credential hierarchy
Keys resolve in priority order — the most specific key wins:
Personal key (user override)
↓ Role-level key (via role AI policy)
↓ Org-level key (shared default)
↓ Platform stub (fallback)Visual Workflow Editor
Workflows are org-scoped automation pipelines built with a ReactFlow visual canvas.
Create a workflow
Go to Workflows in the org nav. Click + New Workflow.
Build with nodes
Drag nodes from the palette and connect them. Node types: Trigger, AI, Condition, HTTP, Delay, Code.
Publish & run
Save as a draft, then Publish a version and set it as Active. Execution history is stored per workflow.
Knowledge Base
Add reference material that the AI uses as context when generating or improving content.
Org-level knowledge
Go to Settings → Knowledge to add org-wide items (text, file upload, or URL fetch).
Project-level knowledge
Inside a project, go to the Knowledge tab. Upload files, paste a URL, or add plain text.
Use in AI chat
In the AI Chat panel, click Attach Knowledge to inject specific items into the current AI conversation context.
MCP Integration
The Model Context Protocol (MCP) lets external AI agents connect to your org's data through a Bearer-token API.
Create an MCP Server Token
In Settings → MCP Tokens, click Create Token. Give it a name (e.g., “Claude Desktop”).
Configure your AI client
Copy the generated token and configure it as the Bearer token in your MCP client. The agent can then read projects, requirements, and tasks within your RBAC scope.
Security & revocation
Tokens respect RBAC — an agent using a Member token cannot access Owner-only resources. Revoke any token instantly from Settings.
Insights & Audit Log
WORK-X logs every action automatically. View them in the Insights page (requires org.audit.view permission).
Activity heatmap
A GitHub-style full-year heatmap shows activity density per day. Select a year on the right. Hover a cell to see a breakdown by category. Timezone is adjustable.
Audit log feed
A paginated, cursor-based list of all actions. Filter by user, project, category, date range, and role.
Per-user activity
Click a team member card (or go to People) to see a full per-user heatmap + timeline with event breakdowns.
Storage Setup
File uploads (requirement attachments, knowledge files) use your org's configured storage provider.
- AWS S3 — bucket + region + access key
- Cloudflare R2 — S3-compatible, zero egress
- MinIO — self-hosted S3-compatible
- Local disk — for local / container deployments
Configure in Settings → Storage. Click Test Connection before saving to validate bucket access.
Database & Data Plane
Three database configurations per org:
Quickest to start — data lives in WORK-X's Postgres. No config needed.
Bring Your Own Database — connect your own Postgres. Connection string is validated before saving.
A dedicated Postgres provisioned for you. Plan-gated. Live migration progress shown.
Configure in Settings → Database. During a migration, write operations are temporarily locked across the org.
Org Settings
Access all org configuration at Settings in the sidebar. Nine tabs:
GeneralOrg name, description, danger zone (delete org).
MembersMember list, invite, manage roles, remove members.
Roles & PermissionsCustom role CRUD, assign permission sets, per-role AI policy.
DatabaseStorage type (shared/BYODB/dedicated), migration management.
StorageS3 / R2 / MinIO / local storage config and connection test.
AI ProviderOrg-level BYOK AI keys — set default, rotate, revoke.
AI TemplatesOrg-level AI prompt templates for consistent AI outputs.
My AI KeysPersonal user-level AI key overrides (highest priority).
MCP TokensIssue and revoke long-lived tokens for external AI agents.