Skip to content

Commit 39d7901

Browse files
committed
Add instructions to create and use the binaries locally
1 parent 3b0cc0a commit 39d7901

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

docs/contributing.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,25 @@ To be able to use it you'll have to add `$HOME/.vtex/dev/bin` to your `PATH` env
1515

1616
That's it! Now you're able to run `yarn watch` and, on another terminal session, use the command `vtex-test` as an alias to what you're developing.
1717

18+
### Building the binaries locally and testing them
19+
You can build the binaries and test it locally. You can run the commands:
20+
21+
```
22+
yarn build && yarn oclif-dev pack
23+
```
24+
25+
A folder named `dist` will be created with all the binaries for different OS. The command below enable to use the binaries for MacOS:
26+
27+
```
28+
tar -xzf /Users/fila/Code/vtex/toolbelt/dist/vtex-v4.3.0/vtex-v4.3.0-darwin-x64.tar.gz -C ~/.local/vtex # or copy it to any other folder you want
29+
```
30+
31+
Now, you can use the binaries in a VTEX IO App as:
32+
33+
```
34+
~/.local/vtex/vtex/bin/vtex --version # or any other command
35+
```
36+
1837
### Adding commands
1938

2039
The VTEX CLI uses [Ocliff](https://oclif.io/) under the hood, making it very easy to add or improve commands. Follow [this guide](https://oclif.io/docs/commands) to learn how to develop on this project.

0 commit comments

Comments
 (0)