grafana/.citools
Matheus Macabu fa831577f1
Dependencies: Bump github.com/go-viper/mapstructure/v2 to 2.4.0 (#110201)
2025-08-27 11:28:10 +02:00
..
src Dependencies: Bump github.com/go-viper/mapstructure/v2 to 2.4.0 (#110201) 2025-08-27 11:28:10 +02:00
README.md Chore: Detaching go tools from the main Grafana workspace (#104861) 2025-05-21 11:22:24 +02:00
Variables.mk CiTools: Install air (#108367) 2025-07-21 12:25:40 +02:00
generate.sh Chore: Detaching go tools from the main Grafana workspace (#104861) 2025-05-21 11:22:24 +02:00
install.sh Chore: Detaching go tools from the main Grafana workspace (#104861) 2025-05-21 11:22:24 +02:00

README.md

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/lefthook@v1.11.10

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:
    $(bra) 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>