# Earthbuild Documentation

## Docs

- [Introduction](https://docs.earthbuild.dev/readme.md)
- [Install EarthBuild](https://docs.earthbuild.dev/install.md)
- [Migrating from Earthly](https://docs.earthbuild.dev/migrating-from-earthly.md)
- [Learn the basics](https://docs.earthbuild.dev/basics.md)
- [Part 1: A simple Earthfile](https://docs.earthbuild.dev/basics/part-1-a-simple-earthfile.md)
- [Part 2: Outputs](https://docs.earthbuild.dev/basics/part-2-outputs.md)
- [Part 3: Adding dependencies With Caching](https://docs.earthbuild.dev/basics/part-3-adding-dependencies-with-caching.md)
- [Part 4: Args](https://docs.earthbuild.dev/basics/part-4-args.md)
- [Part 5: Importing](https://docs.earthbuild.dev/basics/part-5-importing.md)
- [Part 6: Using Docker In EarthBuild](https://docs.earthbuild.dev/basics/part-6-using-docker-with-earthbuild.md)
- [Part 7: Using remote runners](https://docs.earthbuild.dev/basics/part-7-using-remote-runners.md)
- [Part 8a: Using EarthBuild in your current CI](https://docs.earthbuild.dev/basics/part-8a-using-earthbuild-in-your-current-ci.md)
- [Final words](https://docs.earthbuild.dev/basics/final-words.md)
- [Featured guides](https://docs.earthbuild.dev/featured-guides.md)
- [Rust](https://docs.earthbuild.dev/featured-guides/rust.md)
- [Guides](https://docs.earthbuild.dev/docs/guides.md)
- [Importing](https://docs.earthbuild.dev/docs/guides/importing.md)
- [Target and artifact references](https://docs.earthbuild.dev/docs/guides/target-ref.md)
- [Build arguments and variables](https://docs.earthbuild.dev/docs/guides/build-args.md)
- [Secrets](https://docs.earthbuild.dev/docs/guides/secrets.md)
- [Functions](https://docs.earthbuild.dev/docs/guides/functions.md)
- [Using Docker in EarthBuild](https://docs.earthbuild.dev/docs/guides/docker-in-earthbuild.md)
- [Multi-platform builds](https://docs.earthbuild.dev/docs/guides/multi-platform.md)
- [Authenticating Git and image registries](https://docs.earthbuild.dev/docs/guides/auth.md)
- [Integration Testing](https://docs.earthbuild.dev/docs/guides/integration.md)
- [Debugging techniques](https://docs.earthbuild.dev/docs/guides/debugging.md)
- [Podman](https://docs.earthbuild.dev/docs/guides/podman.md)
- [Apple Container](https://docs.earthbuild.dev/docs/guides/apple-container.md)
- [Configuring registries](https://docs.earthbuild.dev/docs/guides/configuring-registries.md)
- [AWS ECR](https://docs.earthbuild.dev/docs/guides/configuring-registries/aws-ecr.md)
- [GCP Artifact Registry](https://docs.earthbuild.dev/docs/guides/configuring-registries/gcp-artifact-registry.md)
- [Azure ACR](https://docs.earthbuild.dev/docs/guides/configuring-registries/azure-acr.md)
- [Self-signed certificates](https://docs.earthbuild.dev/docs/guides/configuring-registries/self-signed.md)
- [Using the EarthBuild Docker Images](https://docs.earthbuild.dev/docs/guides/using-the-earthbuild-docker-images.md)
- [earthbuild/earthbuild](https://docs.earthbuild.dev/docs/guides/using-the-earthbuild-docker-images/all-in-one.md)
- [earthbuild/buildkitd](https://docs.earthbuild.dev/docs/guides/using-the-earthbuild-docker-images/buildkit-standalone.md)
- [Best practices](https://docs.earthbuild.dev/docs/guides/best-practices.md)
- [Caching](https://docs.earthbuild.dev/docs/caching.md)
- [Caching in Earthfiles](https://docs.earthbuild.dev/docs/caching/caching-in-earthfiles.md)
- [Managing cache](https://docs.earthbuild.dev/docs/caching/managing-cache.md)
- [Caching via remote runners](https://docs.earthbuild.dev/docs/caching/caching-via-remote-runners.md)
- [Remote runners](https://docs.earthbuild.dev/docs/remote-runners.md)
- [Earthfile reference](https://docs.earthbuild.dev/docs/earthfile.md)
- [Builtin args](https://docs.earthbuild.dev/docs/earthfile/builtin-args.md)
- [Excluding patterns](https://docs.earthbuild.dev/docs/earthfile/earthignore.md)
- [Version-specific features](https://docs.earthbuild.dev/docs/earthfile/features.md)
- [The earth command](https://docs.earthbuild.dev/docs/earth-command.md)
- [EarthBuild lib](https://docs.earthbuild.dev/docs/earthbuild-lib.md)
- [Configuration reference](https://docs.earthbuild.dev/docs/earth-config.md)
- [Examples](https://docs.earthbuild.dev/docs/examples.md)
- [Misc](https://docs.earthbuild.dev/docs/misc.md)
- [Alternative installation](https://docs.earthbuild.dev/docs/misc/alt-installation.md)
- [Definitions](https://docs.earthbuild.dev/docs/misc/definitions.md)
- [Public key authentication](https://docs.earthbuild.dev/docs/misc/public-key-auth.md)
- [Overview](https://docs.earthbuild.dev/ci-integration/overview.md)
- [Use the EarthBuild CI Image](https://docs.earthbuild.dev/ci-integration/use-earthbuild-ci-image.md)
- [Build your own EarthBuild CI Image](https://docs.earthbuild.dev/ci-integration/build-an-earthbuild-ci-image.md)
- [Pull-Through Cache](https://docs.earthbuild.dev/ci-integration/pull-through-cache.md)
- [Remote BuildKit](https://docs.earthbuild.dev/ci-integration/remote-buildkit.md)
- [Vendor-Specific Guides](https://docs.earthbuild.dev/ci-integration/vendor-specific-guides.md)
- [GitHub Actions](https://docs.earthbuild.dev/ci-integration/vendor-specific-guides/gh-actions-integration.md)
- [Circle CI](https://docs.earthbuild.dev/ci-integration/vendor-specific-guides/circle-integration.md)
- [GitLab CI/CD](https://docs.earthbuild.dev/ci-integration/vendor-specific-guides/gitlab-integration.md)
- [Jenkins](https://docs.earthbuild.dev/ci-integration/vendor-specific-guides/jenkins.md)
- [AWS CodeBuild](https://docs.earthbuild.dev/ci-integration/vendor-specific-guides/codebuild-integration.md)
- [Google Cloud Build](https://docs.earthbuild.dev/ci-integration/vendor-specific-guides/google-cloud-build.md)
- [Bitbucket Pipelines](https://docs.earthbuild.dev/ci-integration/vendor-specific-guides/bitbucket-pipelines-integration.md)
- [Woodpecker CI](https://docs.earthbuild.dev/ci-integration/vendor-specific-guides/woodpecker-integration.md)
- [Kubernetes](https://docs.earthbuild.dev/ci-integration/vendor-specific-guides/kubernetes.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
This site has an agentic ask interface you may use to query the documentation dynamically by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.earthbuild.dev/index.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
