Browse documentation
Composal documentation
Documentation
Install Composal and learn the source control, agent, and deployment workflows that ship today.
On this page
Start with one shared repository
Composal gives people and coding agents one source-control workflow from a local checkout through review, landing, and deployment. Every organization has a Home repository at <org>/home: imported projects and native work meet in that shared history.
If you are new to Composal, take the Quickstart. It installs the CLI, signs you in, sets up your agent tools, creates or imports a repository, and lands a first change.
Terminal
curl -fsSL https://dl.composal.ai/install.sh | sh
The installer needs no sudo and configures your shell’s PATH automatically. Open a new terminal if prompted, then continue:
Terminal
com login
com clone <org>/home
Choose a workflow
Work with source
- Source control explains changes, repositories, and the landing queue.
- Import and sync connects GitHub or another Git remote.
- Git command comparison maps everyday Git tasks to Composal-native workflows.
- GitHub materialization keeps a monorepo folder and GitHub repository in sync.
Bring agents along
- Set up coding agents installs Composal skills, optional MCP tools, and opt-in Agent Context hooks.
- The machine-readable agent import prompt is a separate, stable path an agent can follow when importing repositories.
Deploy and operate
- Hosting covers apps, services, deployments, domains, CDN, and static sites.
- Composal Hub registry covers org-scoped container repositories at
registry.vex.sc. - CI covers workflow setup, runners, caching, selective execution, and merge-queue validation.
Reference
- CLI reference provides task-oriented command shapes; use
com <command> --helpfor flags in your installed version. - CLI changelog is the complete versioned release history for the command line tool.
- OpenAPI reference links the generated public API contract.
- Product changelog keeps browser documentation updates separate from CLI releases.