CONTRIBUTING.md

Dev Setup instructions

1. Setup go
2. Clone this repo: git clone [email protected]:auth0/auth0-cli
3. make test - ensure everything works correctly. Should see things pass.

Build and run on native platform

From the top-level directory:

$ make build
$ ./auth0 --help

Adding a new command

This part is not fully fleshed out yet, but here are the steps:

1. Create a command (example: https://github.com/auth0/auth0-cli/blob/main/internal/cli/login.go)
2. Add the command constructor to the root command: (e.g. somewhere here: https://github.com/auth0/auth0-cli/blob/main/internal/cli/root.go)

Test it out by doing:

go run ./cmd/auth0 <your command>

Adding a new go dependency

If you have to add another go dependency, you can follow the steps:

1. go get -u github.com/some/path/to/lib
2. Import the library you need in the relevant file. (This step is necessary, so the next steps informs go mod that this dependency is actually used).
3. go mod tidy
4. go mod vendor

We use vendoring, so the last step is required.