# AGENTS.md

A tool for creating and running Linux containers using lightweight virtual machines on a Mac. It is written in Swift, and optimized for Apple silicon. 

## Setup

```
# TODO: the install command. No lockfile was found, so this could not be inferred.
```

## Commands

```
make build          # produce a build
make build-tests
make coverage-all
make cli
make container
make release
```

## Layout

- `Sources/` 335 source files
- `Tests/`   107 source files
- `scripts/` 7 source files

## Conventions

- Tests live alongside the code they cover, following `Tests/ContainerAPIClientTests/ArchTests.swift`.
- CI defines what passing means. See `.github/workflows/common.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- No lockfile is committed, so an install here may not match what CI produced.

---

Drafted by agentreadme.com from what is in this repository. Everything marked TODO
needs a human. Check it in as AGENTS.md at the root.