README

API

Adding and Upgrading Tools

To add a new tool, execute the installation script:

install.sh <tool>

Example

The following command will add lefthook to the tracked tools if it is not already installed, or update its version:

install.sh github.com/evilmartians/[email protected]

Behind the scenes, the script performs a few simple steps:

• Creates a Go module under the .citools/src/<toolname> directory to track the tool version and its dependencies.
• Creates a reference to the tool binary in the .citools/Variables.mk file.

Using Tools in the Makefile

Our Makefile imports .citools/Variables.mk, so you can call a tool binary using standard Make syntax.

Example

run:
    $(cue) run

Using Tracked Tools Without the Makefile

If you want to use a tool outside of the Makefile, you can locate the tool binary by executing the following command:

GOWORK=off go tool -n -modfile=<path_to_modfile> <toolname>