We believe that anyone should be empowered to leverage real-time data. Using the Meroxa CLI, you can build data infrastructure in minutes not months.
Website | Documentation | Installation Guide | Contribution Guide | Twitter
Meroxa is documented publicly in https://docs.meroxa.com/docs, but on each build we also generate Markdown files for each command, exposing the available commands and help for each one. Check it out at docs/commands/meroxa.
For a complete guide to contributing to the Meroxa CLI, see the Contribution Guide.
Please follow the installation instructions in the Meroxa Documentation.
Currently, we provide pre-built Meroxa binaries for macOS (Darwin) Windows, and Linux architectures.
See Releases.
Prerequisite Tools:
To build from source:
- The CLI depends on meroxa-go (which is currently a private repo). To update vendoring the dependency, you'll need to run the following:
make gomod
- Build CLI as
meroxabinary:
make build
A goreleaser GitHub Action is configured to automatically build the CLI and cut a new release whenever a new git tag is pushed to the repo.
- Tag -
git tag -a vX.X.X -m "<message goes here>" - Push -
git push origin vX.X.X
With every release, a new Homebrew formula will be automatically updated on meroxa/homebrew-taps.
If you want to make sure everything's correct before pushing to GitHub, you'll need to install golangci-lint and run:
$ golangci-lint run
Example:
❯ golangci-lint run
cmd/display.go:60:6: `appendCell` is unused (deadcode)
func appendCell(cells []*simpletable.Cell, text string) []*simpletable.Cell {
^
To run the test suite:
make test
If you want to enable shell completion manually, you can generate your own using our meroxa completion command.
Type meroxa help completion for more information, or simply take a look at our documentation.