Skip to content

Add instructions for making a local build on Windows to README #447

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
FayeSGW merged 1 commit into from
Feb 20, 2025
Merged

Add instructions for making a local build on Windows to README #447

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,26 @@ See the [docs](https://docs.kosli.com/client_reference/)

`make lint`

## Building the code
## Building the code (Mac/Linux)

`make build`

Then to run Kosli commands:
`./kosli [COMMAND]`

## Building the code (Windows)

Windows will not allow building using the makefile, so we need to run the commands directly in the terminal.

`set GOFLAGS=""`
`go mod download`
`go mod tidy`
`go vet ./...`
`go build -o kosli.exe -ldflags '-extldflags "-static"' ./cmd/kosli/`

Then to run Kosli commands:
`./kosli.exe [COMMAND]` or `.\kosli.exe [COMMAND]`

## Building the documentation

`make hugo-local`
Expand Down