E

Documentation Improvement Request for Earthly

Summary

The user is asking how to pass a single argument to Earthly at runtime, similar to Podman's -e ARCH=x86_64, without using a .args file for each execution. They mention the syntax earthly +my-target --ARCH=x86_64 as a potential solution but find it inadequately highlighted in the documentation. The user suggests that this example should be made more prominent in the documentation for the ARG command and included in the help section for Earthly, particularly in the USAGE: section of --help. They also express willingness to contribute a pull request to improve the documentation.

Status
resolved
Tags
    Source
    #earthly
      k

      kallisti05

      9/11/2024

      can do. Thanks!

      b

      brandon

      9/11/2024

      If you have time to contribute, a PR would really help us out :pray:

      b

      brandon

      9/11/2024

      Yeah perhaps in the USAGE: section of --help

      k

      kallisti05

      9/11/2024

      --ARGNAME=ARGVALUE - Arbitrary setting of individual ARGs or something

      b

      brandon

      9/11/2024

      Or in the docs for the <https://docs.earthly.dev/docs/earthly-command|earthly command>

      k

      kallisti05

      9/11/2024

      maybe in the help for earthly?

      b

      brandon

      9/11/2024

      There's an example in <https://docs.earthly.dev/docs/guides/build-args|the guide> but perhaps it could be more obviously called in the docs for the ARG command :thinking_face:

      k

      kallisti05

      9/11/2024

      Nice! I didn't see this called out in the docs. Thanks!

      b

      brandon

      9/11/2024

      You should be able to with this kind of syntax: earthly +my-target --ARCH=x86_64

      k

      kallisti05

      9/11/2024

      Hey, how do you provide single ARG's to earthly at runtime? podman has -e ARCH=x86_64 I really don't want to have to create a .args file on every run and update it for a single var.