# Where to Find Apple Container Documentation: Complete Guide to the Repository > Find comprehensive apple container documentation within the GitHub repository and on the official API site. Explore the README and docs folder for all essential information. - Repository: [Apple/container](https://github.com/apple/container) - Tags: getting-started - Published: 2026-06-27 --- **Apple container documentation is hosted entirely within the GitHub repository under the `docs/` folder and root [`README.md`](https://github.com/apple/container/blob/main/README.md), supplemented by a generated API site at https://apple.github.io/container/documentation/.** The apple/container repository maintains all user-facing documentation alongside its source code on the `main` branch, making the repository the single source of truth for installation guides, architectural deep-dives, and CLI references. Understanding the documentation structure allows you to locate technical specifications, command references, and tutorials without searching external sites. ## Documentation Locations in the Repository The project organizes documentation into logical sections within the repository root and the `docs/` directory. All files are version-controlled and searchable via GitHub's interface. ### Root README and Entry Points The [`README.md`](https://github.com/apple/container/blob/main/README.md) file serves as the primary landing page, containing high-level project descriptions, installation steps, and quick-start links. It points readers to the full API documentation site and provides immediate orientation for new users. ### Technical Architecture Documentation For developers needing to understand the underlying virtualization model, [`docs/technical-overview.md`](https://github.com/apple/container/blob/main/docs/technical-overview.md) provides a concise architectural description. This file explains how the **Apple Containerization Swift package** integrates with the **macOS Virtualization framework**, **vmnet frameworks**, and **XPC helper processes** to provide secure containerization on Apple Silicon. ### Command Reference and CLI Guide The [`docs/command-reference.md`](https://github.com/apple/container/blob/main/docs/command-reference.md) file contains the complete CLI specification for the `container` binary. It documents all subcommands including `container run`, `container build`, and `container system` with their respective flags, usage examples, and platform-specific notes. ### How-To Guides and Tutorials Practical implementation guidance resides in [`docs/how-to.md`](https://github.com/apple/container/blob/main/docs/how-to.md), covering recipes for building images, publishing ports, configuring networking, and using init images. For step-by-step learning, [`docs/tutorials/start-here.md`](https://github.com/apple/container/blob/main/docs/tutorials/start-here.md) walks beginners through building, running, and publishing a simple web-server image from scratch. ### Generated API Documentation Site While markdown files cover user guides, the generated Swift-Doc site at `https://apple.github.io/container/documentation/` mirrors the source-code API. This site is linked from the main README and updates automatically with the codebase. ## Key Documentation Files and Structure The repository contains several specialized documents beyond the primary guides: - **[`docs/technical-overview.md`](https://github.com/apple/container/blob/main/docs/technical-overview.md)** – Architectural deep-dive into VM models, security boundaries, and performance characteristics - **[`docs/command-reference.md`](https://github.com/apple/container/blob/main/docs/command-reference.md)** – Exhaustive CLI reference with flag descriptions and shell examples - **[`docs/how-to.md`](https://github.com/apple/container/blob/main/docs/how-to.md)** – Task-oriented recipes for common operations like volume mounts and resource constraints - **[`docs/tutorials/start-here.md`](https://github.com/apple/container/blob/main/docs/tutorials/start-here.md)** – Beginner tutorial creating a functional web server container - **[`docs/container-system-config.md`](https://github.com/apple/container/blob/main/docs/container-system-config.md)** – Configuration schema documentation for system-level settings - **[`docs/bug-report-how-to.md`](https://github.com/apple/container/blob/main/docs/bug-report-how-to.md)** – Guidelines for filing effective bug reports and contributing fixes - **[`Package.swift`](https://github.com/apple/container/blob/main/Package.swift)** – Swift package manifest defining the `container` CLI target and dependency graph ## Practical Examples from the Documentation The following examples are reproduced from [`docs/command-reference.md`](https://github.com/apple/container/blob/main/docs/command-reference.md) and demonstrate the most frequently used CLI patterns. Run a container interactively with a shell: ```bash container run -it ubuntu:latest /bin/bash ``` Build an image with multiple tags: ```bash container build -t my-app:latest -t my-app:v1.0.0 . ``` Run a background web server with port publishing: ```bash container run -d --name web -p 8080:80 nginx:latest ``` Execute a container with an init process to reap zombie processes: ```bash container run --init ubuntu:latest my-app ``` ## Summary - **Apple container documentation** lives entirely within the GitHub repository under [`README.md`](https://github.com/apple/container/blob/main/README.md) and the `docs/` folder on the `main` branch - **Technical architecture** is documented in [`docs/technical-overview.md`](https://github.com/apple/container/blob/main/docs/technical-overview.md), covering Virtualization framework integration and XPC helper processes - **CLI reference** is maintained in [`docs/command-reference.md`](https://github.com/apple/container/blob/main/docs/command-reference.md) with exhaustive command and flag listings - **Learning resources** include [`docs/tutorials/start-here.md`](https://github.com/apple/container/blob/main/docs/tutorials/start-here.md) for beginners and [`docs/how-to.md`](https://github.com/apple/container/blob/main/docs/how-to.md) for specific tasks - **API documentation** is generated at https://apple.github.io/container/documentation/ and linked from the README - All documentation updates are version-controlled alongside the source code ## Frequently Asked Questions ### Where is the official apple container documentation hosted? The official documentation is hosted directly within the apple/container GitHub repository. All user-facing guides, technical specifications, and CLI references reside in the `docs/` folder and the repository's [`README.md`](https://github.com/apple/container/blob/main/README.md), ensuring documentation stays synchronized with code releases. ### How do I access the apple container CLI command reference? Navigate to [`docs/command-reference.md`](https://github.com/apple/container/blob/main/docs/command-reference.md) in the repository root, which contains the complete specification for the `container` binary. This file documents every subcommand including `container run`, `container build`, and `container system` with their flags, arguments, and platform-specific usage examples. ### Is there a tutorial for beginners in the apple container repository? Yes, the repository includes [`docs/tutorials/start-here.md`](https://github.com/apple/container/blob/main/docs/tutorials/start-here.md), a step-by-step tutorial that guides new users through building, running, and publishing a simple web-server image. For additional practical guidance, [`docs/how-to.md`](https://github.com/apple/container/blob/main/docs/how-to.md) provides task-oriented recipes covering common workflows like port publishing and volume mounting. ### Does apple container have external documentation outside of GitHub? While the primary documentation lives in the repository, the project maintains a generated API documentation site at https://apple.github.io/container/documentation/. This site mirrors the Swift source code API and is automatically updated alongside the repository, but all user guides and tutorials remain in the GitHub-hosted markdown files.