Documentation
Build with Aexy
The AI company operating system, fully documented. Architecture deep dives, cross-cutting guides, API conventions, and per-module references — 74 pages, all generated from the source repo.
Architecture & Design
4 pagesAPI Reference
2 pagesFor administrators
7 pagesSetting up a workspaceThe first hour: people, apps, departments, modulesRoles, permissions & app accessWhy two colleagues see different things, and how to change itEmail and inbox setupMail arriving and mail leaving, and which module reads whichImporting your dataCRM, prospects, wikis and spreadsheets, and what no import does for youWorking hours, holidays & the clocksThe shift, the one holiday calendar, and which clock is whichGetting your data outWhat each module exports, which format to choose, and the PDF caveatNotifications & digestsPer-person notifications, per-module digests, and how to stop each
Getting started & operations
5 pagesDeveloper guides (cross-cutting)
9 pagesAdding a featureFull-stack checklist for a new moduleAPI conventionsURL shape, pagination, errors, status codesAuthentication & permissionsJWT, OAuth, workspaces, RBAC, API tokensTemporalWorkflows, activities, schedules, retries, idempotencyWebhooksInbound + outbound signing and deliveryFile uploads & object storageRustFS / S3 + presigned URLs + AI metadata pipelineInternationalization (i18n)next-intl, cookie-based locale, message filesFrontend conventionsApp Router, React Query, Zustand, generated clientAexy Email Infrastructure
Provider setup
6 pagesGoogle integrationSign-in, Gmail & CalendarMicrosoft integrationSign-in, Outlook & Calendar (Microsoft Graph)SlackBot install, slash commands, OAuthStripeBilling & subscriptionsMCP (Model Context Protocol)Connect Claude Code, Claude Desktop, Codex, Cursor & VS Code to AexyOpenObserveLog and trace shipping
Modules — Work & planning
10 pagesSprints & planningThe board, the backlog, running a cycle, estimating togetherSprints & planning architectureModels, lifecycle endpoints, poker sessions, external syncTickets & projectsRaising tickets, where the queue lives, forms, converting to workTickets & projects architectureThe four work-item models, statuses, sync, public projectsService DeskRunning a desk: mailboxes, master data, handoffs, the clock, reportsService Desk architectureHow it is built: intake pipeline, models, API, frontendBookingMeeting types, availability, team assignment, the public linkBooking architecture & setupGoogle/Microsoft setup, endpoints, RSVP, schemaTrackingStandups, time entries, blockers, entity activityAexy TrackermacOS work tracker + AI auto-attribution (timesheet, journals, insights)
Modules — Core
3 pagesModules — People
7 pagesReviews, hiring & learningRunning a review cycle, goals, assessments, learning pathsPeople architectureModels, workflow states, AI usage, external content sourcesComplianceMandatory training, certifications, evidence, escalationCompliance architectureModels, schedules, questionnaires, the audit logReminders (guide)The narrower how-to for recurring compliance remindersLeaveTypes, policies, balances, requesting and approving, the holiday calendarLeave architectureEndpoints, models, the request workflow, carry-forward
Modules — Customers
8 pagesCRMObjects and records, lists, pipelines, automations, sequencesCRM architectureStorage, the attribute system, the automation engine, webhooksGTMLead scoring, ABM, outreach sequences, intent, expansion playbooksFormsTemplates, building a form, the public link, routing what it collectsForms architectureModel, public submission flow, the builder API, question bankTablesCustom tables, typed fields, saved views, who sees which rowsTables architectureShared CRM storage, view types, access modes, the audit trailEmail MarketingCampaigns, automation & infrastructure
Modules — AI & knowledge
5 pagesAI AgentsLangGraph-based agents with CRM/email toolsWorkflows & automationsAutomation triggers/actions + visual workflows + agent policiesKnowledge baseSpaces, pages, collaborative editing, review and freshness, search, publishing, import & exportDocuments, Drive & Knowledge GraphArchitecture behind the above, plus Drive, the AI metadata pipeline and MCPDriveFiles, folders, smart views, quota