milpa help docs milpa repo

Repositories are folders that contain a .milpa folder within. Use the MILPA_PATH environment variable to tell milpa where to look for repos (see milpa itself docs environment). By default, milpa will prepend any folder named .milpa at the top-level of a git repository to the MILPA_PATH.

Repositories must contain a commands folder, with commands, and may also include utils to be used by command executables, hooks that modify the environment of milpa commands, and docs, to document anything related to your milpa repo.

Finally, milpa provides commands under milpa itself repo to manage install, list and uninstall repositories from remote sources.

Let's say you have this in your repo:

.milpa/
  commands/
    vault/
      cloud-provider/
        login
        login.yaml
      db/
        connect.sh
        connect.yaml
        list.sh
        list.yaml
    vpn/
      connect
      connect.yaml
    onboard.sh
    onboard.yaml
    release.sh
    release.yaml
  docs/
    welcome.md
    sdlc/
      releasing.md
  hooks/
    before-run.sh
  util/
    date.sh
    etc.sh
    github.sh

Then, milpa would allow you to run milpa vault cloud-provider login and milpa onboard, as well as milpa vault db connect api --environment production --verbose, or even milpa help vault db list and so on and so forth. You choose how to organize your milpa commands under .milpa/commands, and milpa figures out the rest. Reading your welcome docs is as easy as milpa help docs welcome.

Using @milpa.load_util your posix-compliant shell scripts will be able to use any utils anywhere in the MILPA_PATH, for example, you could @milpa.load_util github and use any github-related functions in any of your repo's milpa commands.

Before any command runs, .milpa/hooks/before-run.sh will be called. See hooks.

Ideally, you'll only store milpa-related files in your .milpa repo, as adding more files (specifically to the commands folder, will impact performance).