components-contrib/.build-tools
Cassie Coyle 896679e0b0
fix typo to direct users to proper part on docs page (#3193)
Signed-off-by: Cassandra Coyle <cassie@diagrid.io>
2023-10-25 09:57:40 -07:00
..
cmd Add metadata analyzer tools (#2696) 2023-03-24 18:34:36 +00:00
pkg fix typo to direct users to proper part on docs page (#3193) 2023-10-25 09:57:40 -07:00
.gitignore Component metadata schema and tools (#2077) 2022-09-27 10:44:54 -07:00
README.md Metadata parser: add support for built-in authentication profiles and metadata properties (#2760) 2023-04-12 00:04:34 +00:00
builtin-authentication-profiles.yaml [GCP Bindings Bucket] Adds Component Metadata Schema (#2936) 2023-08-04 07:45:16 -07:00
component-folders.yaml [Metadata] Update validator and some other fixes (#2984) 2023-07-17 22:17:22 +00:00
go.mod Update a number of dependencies (#3160) 2023-10-03 22:44:30 +00:00
go.sum Update a number of dependencies (#3160) 2023-10-03 22:44:30 +00:00
main.go [Metadata] Update validator and some other fixes (#2984) 2023-07-17 22:17:22 +00:00

README.md

dapr/components-contrib build-tools CLI

This folder contains a CLI that implements a number of build tools used by dapr/components-contrib.

The CLI is written in Go and based on the cobra framework. In order to use it, Go (1.18+) must be installed on your system.

Running the CLI

You have two ways to run the CLI:

  1. Within the build-tools directory, you can run the CLI with go run . directly. For example go run . help shows the help page.
  2. You can build a pre-compiled binary by running make compile-build-tools in the root folder of this repository. This will build an executable called build-tools (or build-tools.exe on Windows) in the build-tools folder. You can then run the command directly, for example ./build-tools help

Available commands

The list of available commands in this CLI is dynamic and is subject to change at any time. Each command, including the "root" one (no sub-command), are self-documented in the CLI, and you can read the help page by adding --help.

For example, ./build-tools --help shows the full list of commands the CLI offers.