Documentation · 40 Pages

Team-X documentation.

Everything you need to install Team-X, configure providers, hire from the role catalog, and operate the cockpit. Search across 40 pages, or browse by section below.

Search runs entirely client-side via Pagefind. No queries leave your machine.

MOD · Library · 7-CH 40 PAGES · ALL LIVE

Getting started

Getting started Install Team-X, run the first conversation with an AI employee, connect a local LLM via Ollama, and tour the cockpit. Fifteen minutes start to first ticket.
Quick start The 15-minute path: install Team-X, configure one provider, hire your first employee, and file your first ticket. The shortest route from download to operational AI workforce.
Hiring employees The 57-role hand-written catalog, hiring from the pack, custom employees, org chart management, and the rules that govern who can manage whom in a Team-X company.

Using Team-X

Configuring providers Add LLM providers, set privacy tiers, choose a runtime strategy, and cap per-provider concurrency. Nine providers across three tiers, OS keychain for keys.
Command palette The Cmd+K natural-language control surface for the entire app. 14 structured intents plus an agentic-loop fallback, slash-command navigation, history recall, and a destructive-action confirmation gate.
Agentic loop How Team-X answers free-form questions: a ReAct loop with six read-only org query tools, hard step and token budgets, persisted threads, and full audit-log coverage.
Copilot service The periodic analyzer that surfaces operational, cost, org, workflow, and anomaly insights. Ask-the-copilot, feedback weights, suggestion audit trail, and run-kind tagging.
Copilot UI Where copilot insights live: the sidebar panel, the dashboard widget, the Cmd+Shift+K shortcut, category and severity filters, feedback flow, and local CSV/JSON export.
Task planner Decompose projects into tickets, delegate with deterministic workload scoring, review deliverables, and gate every write through an amber confirmation prompt.
Managing projects Goals, projects, tickets, due dates, and the four-column kanban board. How project state flows from the org chart into shippable work.
Scheduling and calendar Calendar view, ticket due dates, project targets, goal targets, reminders, and future agent wakeups. The time dimension of Team-X.
Using the vault File storage, FTS5 search, SHA256 integrity verification, ticket attachments, and agent-created deliverables. Everything an employee writes ends up here.
Demo walkthrough Step-by-step walkthrough of the canonical Team-X demo: hire a CEO, create a ticket, hold an all-hands, ask the copilot, all in under ten minutes.

Advanced

Complete user guide The full Team-X manual in one page. Twenty sections covering every surface from first launch to multi-workspace operations, with deep links into every focused doc.
Autonomy control plane Doctor, benchmarks, agent self-improvement, runtimes, routines, budgets, approvals, artifacts, memory, and operator access. The control surface for unattended runtime work.
Backup and restore Create archives of the SQLite database and the file vault, validate them on restore via the bundled manifest, and recover from any prior point in time.
Migration guide Move workspaces between machines, migrate from prior versions, and handle the few breaking changes Team-X has shipped without losing org state, vault files, or audit history.

Scenarios

Product development lifecycle End-to-end scenario: spin up a product team, file the roadmap, build the MVP, ship the first release, all inside Team-X. The single playbook closest to the launch demo.
Cost optimization playbook How to keep spend in check: provider tier selection, per-ticket budget caps, routine scheduling, and the copilot signals that catch cost anomalies before they compound.
Failure recovery workflows When agents fail, runtimes stall, or tickets block: how to triage, restart, and recover. The reference for the Autonomy > Improve loop in production.
Cross-functional collaboration Multiple employees on one ticket, ticket-thread discussion, meeting handoffs, and the participant-wake semantics that make AI teams collaborate like real ones.
Autonomous routine governance Standing up recurring work safely: routine templates, approval gates, budget caps, the cadence loop, and the audit trail every unattended run leaves behind.
Multi-workspace operations Run multiple AI companies side by side: workspace switching, per-workspace budgets, employees allocated across orgs, and the cost-attribution math that keeps it sane.
Shift handoff playbook Transferring operational responsibility cleanly: the handoff document template, doctor run, copilot brief, and the checklist that a backup operator works through.

Templates

Templates overview The four reusable workflow templates Team-X ships: handoff document, meeting agenda, ticket templates, routine templates. Where to start, what they replace, and how to customize.
Handoff document template Comprehensive handoff documentation for operator transitions: workspace overview, active issues, budgets, contacts, known issues, decision log, and the return plan.
Meeting agenda template Structured agendas for standups, retrospectives, planning sessions, incident post-mortems, and 1:1 check-ins. Timeboxes, attendee roles, prep, and follow-up.
Ticket templates Ten pre-defined ticket formats covering features, bug fixes, code reviews, documentation, testing, research, security, performance, deployment, and refactoring work.
Routine templates Ten pre-configured routines for recurring automation: code review, data sync, weekly summary, security scan, cost anomaly detection, backup, health check, and more.

Developer

API reference Team-X's extension surface is Electron IPC, not a hosted REST API. Typed channels in @team-x/shared-types, a one-way events.dashboard push stream, and two declarative extension entry points (MCP servers and Skills). Local-first, no Bearer auth, no api.team-x.app.
Integration guide Wiring Team-X into your stack. Provider adapters (Ollama, Anthropic, OpenAI, plus six more), MCP server registration, Skills installation, workspace export and import, audit-log streaming, local backup. Local-first; no cloud bridge.
Command reference Team-X has no separate command-line tool. Its command surface is the Command Palette: natural-language commands typed inside the desktop app. Syntax, examples, and why the team-x-ai CLI was removed in v3.5.0.
Release signing and verification What a Team-X release run checks before it can publish: the signature gate, the install-launch-uninstall smoke test, SHA256SUMS, build-provenance attestations, and the SBOM. How to verify a download, and why v3.5.0 ships unsigned.
Branch governance How changes reach main and how releases are tagged: the rulesets on the default branch and on release tags, the four-stage review wall, the break-glass path, and signed release tags.

Reference

What's new Release notes for Team-X, newest first. v3.5.0: enforced privacy tiers, Copilot answers from your own data, the Models tab for local GGUF models, Electron 44, checked installers, and a Linux AppImage that needs no FUSE 2.
Frequently asked questions Common questions about Team-X v3.5.0: open-source MIT licensing, local-first architecture, privacy posture, providers, hardware requirements, and updates.
Keyboard shortcuts Every keybinding in Team-X: navigation, command palette, copilot sidebar, ticket actions, and the productivity shortcuts that keep operators hands-on-keyboard.
Glossary Definitions for every Team-X concept: role specs, levels, runtimes, routines, doctor, copilot, autonomy, vault, FTS5, privacy tiers, and the rest of the vocabulary.
Troubleshooting The reference for when something is wrong: provider connection failures, runtime stalls, agent loop budget exhaustion, file save issues, and the log paths to inspect first.
Accessibility guide Keyboard-only operation, screen-reader support, color contrast, motion-reduction, focus management, and the WCAG 2.1 AA baseline Team-X is built to.