Directory Structure
Entrypoints
API
CLI
UI
Schemas
Build
Test
Security
Bookmarks

.github
- ISSUE_TEMPLATE
- workflows
- PULL_REQUEST_TEMPLATE.md
- dependabot.yml
- stale.yml
cmd
- cmdtrace
  - cmd_span.go
  - cmd_span_test.go
- compatibility
  - convert.go
  - convert_test.go
- compose
  - alpha.go
  - attach.go
  - build.go
  - completion.go
  - compose.go
  - compose_test.go
  - config.go
  - cp.go
  - create.go
  - create_test.go
  - down.go
  - events.go
  - exec.go
  - images.go
  - kill.go
  - list.go
  - logs.go
  - options.go
  - options_test.go
  - pause.go
  - port.go
  - ps.go
  - ps_test.go
  - publish.go
  - pull.go
  - pullOptions_test.go
  - push.go
  - remove.go
  - restart.go
  - run.go
  - scale.go
  - start.go
  - stats.go
  - stop.go
  - top.go
  - up.go
  - up_test.go
  - version.go
  - viz.go
  - viz_test.go
  - wait.go
  - watch.go
- formatter
- main.go
docs
- reference
- yaml
  - main
    - generate.go
internal
- desktop
- experimental
  - experimental.go
- locker
- memnet
- ocipush
  - push.go
- paths
  - paths.go
- sync
  - shared.go
  - tar.go
- tracing
- variables.go
packaging
- LICENSE
pkg
- api
- compose
  - testdata
    - compose.yaml
  - attach.go
  - attach_service.go
  - build.go
  - build_buildkit.go
  - build_classic.go
  - compose.go
  - container.go
  - containers.go
  - convergence.go
  - convergence_test.go
  - convert.go
  - cp.go
  - create.go
  - create_test.go
  - dependencies.go
  - dependencies_test.go
  - desktop.go
  - down.go
  - down_test.go
  - envresolver.go
  - envresolver_test.go
  - errors.go
  - events.go
  - exec.go
  - filters.go
  - hash.go
  - hash_test.go
  - image_pruner.go
  - images.go
  - kill.go
  - kill_test.go
  - logs.go
  - logs_test.go
  - ls.go
  - ls_test.go
  - metrics.go
  - pause.go
  - port.go
  - printer.go
  - ps.go
  - ps_test.go
  - publish.go
  - pull.go
  - push.go
  - remove.go
  - restart.go
  - run.go
  - scale.go
  - secrets.go
  - start.go
  - stop.go
  - stop_test.go
  - top.go
  - up.go
  - viz.go
  - viz_test.go
  - wait.go
  - watch.go
  - watch_test.go
- e2e
- mocks
- progress
  - colors.go
  - event.go
  - noop.go
  - plain.go
  - quiet.go
  - spinner.go
  - tty.go
  - tty_test.go
  - writer.go
  - writer_test.go
- prompt
  - prompt.go
  - prompt_mock.go
- remote
- utils
- watch
.dockerignore
.gitattributes
.gitignore
.golangci.yml
BUILDING.md
CONTRIBUTING.md
Dockerfile
LICENSE
MAINTAINERS
Makefile
NOTICE
README.md
codecov.yml
docker-bake.hcl
go.mod
go.sum
logo.png

Codebase

Navigate the Codebase using the tree view. Use the filters to highlight where various files are grouped to aid understanding.

Getting Started Commands

make build: Compile the application.

make binary: Create a binary for the application.

make all: Execute all the build steps defined.

make build-and-e2e: Build the application and run end-to-end tests.

make build-and-e2e-compose: Build the application and run end-to-end tests with Docker Compose.

make build-and-e2e-compose-standalone: Build the application and run standalone end-to-end tests with Docker Compose.

docker compose up: Start and run the entire application defined in the Compose file.

make test: Execute the test suite for the application.

make e2e: Run end-to-end tests for the application.

make e2e-compose: Run end-to-end tests using Docker Compose.

make binary-with-coverage: Create a binary while measuring test coverage.

make install: Install the application.

make go-mod-tidy: Clean up Go module dependencies.

make mocks: Generate mock implementations for testing.

make lint: Check the code for style and errors using a linter.

make validate: Validate the configuration and setup of the application.

make validate-docs: Check if the documentation is correct.

make validate-go-mod: Validate the Go module definition.

make validate-headers: Ensure proper licensing headers are present.

make pre-commit: Prepare the repository for a commit by running checks.

make cache-clear: Clear build cache.

make check-dependencies: Verify that all dependencies are properly set up.

make cross: Build the application for multiple target platforms.

Project Structure

Below is a short description of the key directories of the project to aid you when understanding where key files are located.

.dockerignore - A file that specifies which files and directories to ignore when building a Docker image.

.gitattributes - A file that specifies attributes for files in the Git repository.

.github/ - This directory contains GitHub-specific configuration files and templates for issues and pull requests.

.gitignore - A file that specifies which files and directories to ignore in the Git repository.

.golangci.yml - A file that configures the golangci linter tool.

BUILDING.md - A document that explains how to build Docker Compose.

cmd/ - This directory contains the command-line interface (CLI) for Docker Compose.

codecov.yml - A file that configures code coverage reporting for the Docker Compose project.

CONTRIBUTING.md - A document that explains how to contribute to the Docker Compose project.

docker-bake.hcl - A file that specifies the configuration for building Docker Compose using the Terraform Docker provider.

Dockerfile - A file that specifies how to build a Docker image for Docker Compose.

go.mod - A file that specifies the Go modules used by the Docker Compose project.

go.sum - A file that contains the checksums for the Go modules used by the Docker Compose project.

internal/ - This directory contains internal packages used by Docker Compose.

LICENSE - A file that specifies the license for the Docker Compose project.

logo.png - A file that contains the logo for the Docker Compose project.

MAINTAINERS - A file that lists the maintainers of the Docker Compose project.

Makefile - A file that contains instructions for building and testing Docker Compose.

NOTICE - A file that contains legal notices for the Docker Compose project.

pkg/ - This directory contains the Go packages for Docker Compose.

pkg/api/ - This directory contains the API package for Docker Compose.

pkg/compose/ - This directory contains the main Compose package for Docker Compose.

pkg/e2e/ - This directory contains the end-to-end (e2e) test files for Docker Compose.

pkg/mocks/ - This directory contains mock files used for testing.

pkg/progress/ - This directory contains progress display utilities.

pkg/prompt/ - This directory contains prompt utilities.

pkg/remote/ - This directory contains remote file handling utilities.

pkg/utils/ - This directory contains utility functions.

pkg/watch/ - This directory contains file watching utilities.

README.md - A document that provides an overview of the Docker Compose project.

Entrypoints

Below are files we identified as entrypoints for to the codebase. This is where the application starts and a good place to start when learning.

cmd/main.go - Path: cmd/main.go

docs/yaml/main/generate.go - Path: docs/yaml/main/generate.go

Codebase

Getting Started Commands

Project Structure

Entrypoints

Explanation

Graph

Symbols

Entrypoints