# Vectis

> Local virtual machines for GitHub Actions, controlled by people and agents.

## Docs

- [Vectis](https://vectis.kerd.dev/docs): GitHub Actions runners in disposable VMs on your own Mac, for people and agents.

## Get started

- [Install Vectis](https://vectis.kerd.dev/docs/get-started/install): Requirements, installation, the background service and the command line tools.
- [Quickstart](https://vectis.kerd.dev/docs/get-started/quickstart): From a freshly installed app to your first GitHub Actions job in a Vectis VM.

## Environments

- [Prepare a Linux environment](https://vectis.kerd.dev/docs/guides/linux-setup): Download and prepare Ubuntu on an Apple Silicon Mac with resumable local setup.
- [Install a macOS guest](https://vectis.kerd.dev/docs/guides/macos-setup): Restore macOS into an owned local bundle and open its setup console.
- [Install a Windows guest](https://vectis.kerd.dev/docs/guides/windows-setup): Prepare a local Windows 11 ARM64 image with private setup credentials and pinned SSH access.
- [Derive an environment](https://vectis.kerd.dev/docs/guides/environments): Provision a new immutable image from an existing ready environment.
- [VM storage and resources](https://vectis.kerd.dev/docs/guides/storage): Choose VM locations, CPU and memory limits, and inspect disk usage.

## Guides

- [Repositories and labels](https://vectis.kerd.dev/docs/guides/repositories): Connect repositories to a Mac, choose the runs-on label, and meet the rules for organizations and public repositories.
- [Runners and jobs](https://vectis.kerd.dev/docs/guides/runners): Automatic and manual runners, reading job results, cancelling and recovering.
- [Migrate repository workflows](https://vectis.kerd.dev/docs/guides/migrations): Inspect workflow changes and create an idempotent migration pull request.
- [The Vectis app](https://vectis.kerd.dev/docs/guides/app): What each part of the Mac app does, and where to find the CLI and MCP equivalents.
- [Your account](https://vectis.kerd.dev/docs/guides/account): What the connect page at vectis.kerd.dev shows and what you can do there.
- [Remote control](https://vectis.kerd.dev/docs/guides/remote-control): Control your own Vectis machines through the desktop, CLI, or MCP.
- [Agents](https://vectis.kerd.dev/docs/guides/agents): Give coding agents the Vectis skill and MCP server so they can prepare environments, connect repositories and diagnose jobs.
- [Limits and boundaries](https://vectis.kerd.dev/docs/guides/limits): The numeric limits, timeouts and retention windows Vectis applies today.
- [Troubleshooting](https://vectis.kerd.dev/docs/guides/troubleshooting): What to check when a job keeps waiting, a VM does not start, or an operation fails.

## Reference

- [CLI reference](https://vectis.kerd.dev/docs/reference/cli): Every vectis command and option, generated from the CLI help.
- [Operations and output](https://vectis.kerd.dev/docs/reference/operations): Operation states, idempotency keys, waiting, exit codes, errors, labels and environment variables.

## Self-hosting

- [Build from source](https://vectis.kerd.dev/docs/self-hosting/build-from-source): Build Vectis from a checkout, run an isolated development service, and configure native helpers.
- [Package and sign](https://vectis.kerd.dev/docs/self-hosting/packaging): Build and verify the standalone CLI, MCP server, and local service.
- [Run your own cloud](https://vectis.kerd.dev/docs/self-hosting/cloud): Deploy the Convex backend, Clerk sign-in, website, and GitHub App behind your own Vectis builds.
- [Private development environment](https://vectis.kerd.dev/docs/self-hosting/development-environment): Run a development copy of the website, connect page, and backend that only you can reach.

## Agent skills

- [vectis](https://vectis.kerd.dev/docs/.well-known/agent-skills/vectis/SKILL.md): Read the Vectis docs instead of answering from memory. Local virtual machines for GitHub Actions, controlled by people and agents. Use when a task involves Vectis: how it works, how to set it up or configure it, or its API.

## Agent resources

- [llms-full.txt](https://vectis.kerd.dev/docs/llms-full.txt): The full Markdown of every page in one file.
- [Page Markdown](https://vectis.kerd.dev/docs/index.md): Append `.md` to any page URL to fetch that page as raw Markdown.
- [JSON API](https://vectis.kerd.dev/docs/api/docs/pages.json): Page index of the JSON docs API; each entry links the page's JSON and Markdown forms. Described by the OpenAPI document at https://vectis.kerd.dev/docs/openapi.json.
- [Agent skills](https://vectis.kerd.dev/docs/.well-known/agent-skills/index.json): Agent Skills discovery index of the skills this site publishes.
- [API catalog](https://vectis.kerd.dev/docs/.well-known/api-catalog): RFC 9727 linkset of the APIs documented here.
- [AI catalog](https://vectis.kerd.dev/docs/.well-known/ai-catalog.json): ARD manifest of the agent-facing resources on this site (MCP server, skills, APIs).
- [agent-readability.json](https://vectis.kerd.dev/docs/agent-readability.json): Manifest of every agent-facing artifact on this site.
- [Sitemap](https://vectis.kerd.dev/docs/sitemap.xml): Every indexable page URL with its last-modified date.