# Composal

> Composal provides source control, code review, CI, hosting, and coding-agent integrations for software teams.

Start with the quickstart for installation and your first repository. The CLI executable is `com`; `vex` remains a compatibility alias. Documentation links below return Markdown without navigation or JavaScript. Append `.md` to a documentation page URL to read its Markdown version.

## Get Started

- [Documentation](https://composal.ai/docs.md): A practical map of Composal source control, agents, deployment, and APIs.
- [Quickstart](https://composal.ai/docs/quickstart.md): Install Composal, set up agents, import a repository, and land a first change.
- [Install Composal on macOS](https://composal.ai/docs/macos.md): Install Composal on macOS and verify your local checkout.
- [Use Composal with Windows and WSL](https://composal.ai/docs/windows-wsl.md): Install Composal inside WSL and keep Windows and Linux responsibilities clear.

## CLI

- [CLI reference](https://composal.ai/docs/cli.md): Task-oriented command shapes for the shipped Composal CLI.
- [CLI configuration](https://composal.ai/docs/cli-configuration.md): Set identity, organization context, datacenter defaults, and repository workspace policy.
- [CLI changelog](https://composal.ai/docs/cli/changelog.md): Versioned Composal CLI release notes.

## Repositories and Changes

- [Source control](https://composal.ai/docs/source-control.md): Repositories, local checkouts, changes, reviews, and landing.
- [Live mode (preview)](https://composal.ai/docs/live-mode.md): Network JJ workspaces with ordinary files and automatic synchronization.
- [Submit and stacking](https://composal.ai/docs/submit-and-stacking.md): Submit, review, and stack dependent changes — from a Composal-native checkout or a plain Git clone.
- [Import and sync Git repositories](https://composal.ai/docs/github-sync.md): Import GitHub or generic Git sources and keep an explicit sync contract.
- [GitLab source sync](https://composal.ai/docs/gitlab-sync.md): Connect GitLab.com repositories with Composal.
- [GitHub materialization](https://composal.ai/docs/materialization.md): Keep a GitHub repository and a Composal monorepo folder synchronized.
- [Git command comparison](https://composal.ai/docs/git-comparison.md): Map familiar Git tasks to Composal changes, bookmarks, reviews, and queues.

## CI

- [CI overview](https://composal.ai/docs/ci.md): Set up continuous integration, inspect runs, and configure faster validation on Composal.
- [Configure workflows](https://composal.ai/docs/ci/workflows.md): Create a Composal CI workflow, choose events and path filters, and understand GitHub compatibility.
- [Runners and concurrency](https://composal.ai/docs/ci/runners.md): Understand shared system runners and tune merge-queue candidate concurrency.
- [Selective CI](https://composal.ai/docs/ci/selective.md): Declare monorepo dependencies and verify the workflows needed for submission and landing.
- [Caching](https://composal.ai/docs/ci/caching.md): Configure dependency archives, inspect restores, and measure whether caches save work.
- [Merge queue CI](https://composal.ai/docs/ci/merge-queue.md): Resolve conflicts with Mergiraf, land stacks together, prioritize urgent changes, and reuse published test results.
- [MagicMerge](https://composal.ai/docs/ci/magic-merge.md): Automatically combine remaining text conflicts after Mergiraf when landing through the native merge queue, or retry them locally with the CLI.
- [Inspect and troubleshoot](https://composal.ai/docs/ci/troubleshooting.md): Read CI results, diagnose waiting or failing jobs, and compare runner cost with landing time.
- [CI topic index](https://composal.ai/docs/github-actions-ci.md): Find topics from the previous combined CI guide.

## Agents and Automation

- [Set up coding agents](https://composal.ai/docs/agents.md): Install Composal skills, MCP tools, and opt-in Agent Context support.

## Deploy and Operate

- [Hosting](https://composal.ai/docs/hosting.md): Deploy apps, services, static sites, domains, CDN, and managed resources.
- [Composal Hub registry](https://composal.ai/docs/registry.md): Publish and consume org-scoped container images at registry.vex.sc.
- [Managed OpenTelemetry](https://composal.ai/docs/managed-otel.md): Send organization-scoped telemetry to Composal over authenticated OTLP/HTTP.
- [Billing](https://composal.ai/docs/billing.md): Subscribe, read your usage, and control spend for an organization.

## Reference

- [API reference](https://composal.ai/docs/api.md): Generated OpenAPI, control-plane boundaries, and API authorization notes.
- [Product changelog](https://composal.ai/docs/changelog.md): Public product and documentation updates, separate from CLI releases.

## Agent integrations

- [Agent skill](https://composal.ai/skill.md): Guidance for using Composal from a coding agent.
- [Skills index](https://composal.ai/skills/index.json): Machine-readable catalog of versioned agent skills.
- [Repository import prompt](https://composal.ai/docs/import/prompt.md): Agent instructions for connecting GitHub repositories.