locally is a command line tool design to help spin up a local environment including the infrastructure, the concept is easy, have configuration files created by each team that can be shareable and reproducible from machine to machine and deploy the bare minimum infrastructure.
locally is not installed, it is just an executable with example/template configuration bundle so you can just download the latest release, unzip it to a folder and put it in the environment path.
We have a troubleshoot guide here where we place the most common issues found by people, this will be constantly updated, so please be sure to read it before you ask questions.
If you do not find an answer there you can use the locally channel to ask a question to the team here.
locally is written in Go and uses VSCODE to easily debug, you still need a few tools if you do not have in case you want to build it from source, or just debug it.
Download the latest Go from here, choose your operating system and then run. Note: if you are running Mac or Linux this needs to be unziped to a folder.
Once this is done you can quickly test it by typing go version
There is a good setup guide in here this will use the extensions provided by google and allow intellisense in vscode this is the extension
If you want to test your changes can actually build but not generate the executable follow this:
- Go to the
srcfolder - Run
go build -v ./...
This will just build the code but with no output, if you want to generate an output you can do this
- Go to the
srcfolder - Run
go build -o locally.exe
This will be building the locally but will create a locally.exe as the output