You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Our Meroxa CLI 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 them out at [docs/commands/meroxa](docs/commands/meroxa.md).
13
+
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](docs/commands/meroxa.md).
7
14
8
-
## Our commands
15
+
## Contributing
9
16
10
-
All commands start with `meroxa` which is the name of the binary.
17
+
For a complete guide to contributing to the Meroxa CLI, see the [Contribution Guide](CONTRIBUTING.md).
11
18
12
-
### Build
19
+
##Installation Guide
13
20
14
-
Build CLI as `meroxa` binary:
21
+
Please follow the installation instructions in the [Meroxa Documentation](http://docs.meroxa.com/).
15
22
16
-
```
17
-
make build
18
-
```
23
+
### Build and Install the Binaries from Source (Advanced Install)
19
24
20
-
## Linting
25
+
Currently, we provide pre-built Meroxa binaries for macOS (Darwin) Windows, and Linux architectures.
21
26
22
-
If you want to make sure everything's correct before pushing to GitHub, you'll need to install [`golangci-lint`](https://golangci-lint.run/) and run:
27
+
See [Releases](https://github.com/meroxa/cli/releases).
23
28
24
-
```
25
-
$ golangci-lint run
26
-
```
29
+
Prerequisite Tools:
27
30
28
-
Example:
31
+
*[Git](https://git-scm.com/)
32
+
*[Go](https://golang.org/dl/)
33
+
34
+
To build from source:
35
+
36
+
1. The CLI depends on [meroxa-go](github.com/meroxa/meroxa-go) (which is currently a private repo). To update vendoring the dependency, you'll need to run the following:
29
37
30
38
```
31
-
❯ golangci-lint run
32
-
cmd/display.go:60:6: `appendCell` is unused (deadcode)
33
-
func appendCell(cells []*simpletable.Cell, text string) []*simpletable.Cell {
34
-
^
39
+
make gomod
35
40
```
36
41
37
-
## Vendor
38
-
39
-
The CLI depends on [meroxa-go](github.com/meroxa/meroxa-go) which is currently
40
-
a private repo. To update vendoring the dependency, you'll need to run the following:
42
+
2. Build CLI as `meroxa` binary:
41
43
42
44
```
43
-
make gomod
45
+
make build
44
46
```
45
47
46
48
## Release
@@ -52,12 +54,27 @@ git tag is pushed to the repo.
52
54
* Tag - `git tag -a vX.X.X -m "<message goes here>"`
53
55
* Push - `git push origin vX.X.X`
54
56
55
-
## Tests
57
+
## Linting
58
+
59
+
If you want to make sure everything's correct before pushing to GitHub, you'll need to install [`golangci-lint`](https://golangci-lint.run/) and run:
56
60
57
61
```
58
-
make test
62
+
$ golangci-lint run
59
63
```
60
64
61
-
## Contributing
65
+
Example:
62
66
63
-
See [CONTRIBUTING.md](/CONTRIBUTING.md).
67
+
```
68
+
❯ golangci-lint run
69
+
cmd/display.go:60:6: `appendCell` is unused (deadcode)
70
+
func appendCell(cells []*simpletable.Cell, text string) []*simpletable.Cell {
0 commit comments