# Contribution Guide > Step-by-step guide to setting up Keploy locally for development β€” clone the repo, build from source, and contribute code. # Contribution Guide Welcome to the world of Keploy development! This guide will help you set up Keploy locally. ### 1. **Setting Up Your Platform**: _If you want to try Keploy on macOS or Windows, no worries β€” you’ll just need to set up a Linux VM._ - For macOS, install [Lima](https://github.com/lima-vm/lima#installation). - If you're on Windows, install [WSL](https://learn.microsoft.com/en-us/windows/wsl/install). Note: Linux Users are good to go. ### 2. **Pre-requisites**: First things first, ensure you have [Golang](https://go.dev/doc/install) installed. ### 3. **Clone Keploy Repository**: Time to get your hands on Keploy!: ```shell git clone https://github.com/keploy/keploy.git && cd keploy go mod download ``` Once done, build the binary ```shell go build -race -tags=viper_bind_struct -o keploy . sudo mv keploy /usr/local/bin/ sudo chmod +x /usr/local/bin/keploy ``` **_Now we have successfully set up Keploy. Let’s test it with the sample app._** #### Keploy operates in two modes: - `record`: Capture Keploy test cases from API calls. - `test`: Execute recorded test cases and validate assertions. The Keploy CLI operates by capturing all network traffic between your application and its dependencies. It meticulously records API calls, database queries, and any other interactions your application engages in. Once the recording phase is complete, Keploy can effortlessly generate test cases and data mocks in YAML format. If you don't have any samples app, you can use the [gin-mongo URL Shortener](https://github.com/keploy/samples-go/tree/main/gin-mongo) sample application: #### Let's clone sample app repo: ```shell git clone https://github.com/keploy/samples-go.git && cd samples-go/gin-mongo go mod download # Download dependencies: go build -o gin-mongo-binary # Generate binary of the application: ``` ### 4. Now let's try running keploy: #### Capturing Test Cases: ```shell sudo keploy record -c "path/to/go/binary" ``` #### Running Test Cases: ```shell sudo keploy test -c "path/to/go/binary" --delay 10 ``` Note: Use the `--debug` flag to run Keploy in debug mode for detailed logs. ### Also you can Test Locally Built Docker Image: #### Build Docker Image: Note: Run the below command inside the keploy repository and make sure there is no directory by the name of keploy inside the main keploy repository. ```shell sudo docker image build -t ghcr.io/keploy/keploy:v2-dev . ``` #### Remember setting up the Keploy binary. See [Setup Keploy using Binary](#3-clone-keploy-repository) for details. #### Capture Test Cases: ```shell sudo keploy record -c "docker run -p -p : --name --network keploy-network --rm " ``` #### Running Test Cases: ```shell sudo keploy test -c "docker run -p -p : --name --network keploy-network --rm " --delay 10 ``` There you have it! With this guide, you're all set to dive into Keploy development. Happy testing! πŸ§ͺπŸ”πŸ’» > **Note** :- Run `go run github.com/99designs/gqlgen generate --config pkg/graph/gqlgen.yml` to generate the graphql server stubs which can be used when working with unit testing libraries like JUnit, PyTest, etc.. Hope this helps you out, if you still have any questions, reach out to us on [Slack](https://keploy.io/slack). ## Installing the Open Source Build To install the open-source version of Keploy, use the `--oss` flag: :::info Make sure your Linux kernel version is **5.10 or higher**. ::: πŸ‘‰ **Choose your preferred method:** ### 1. Install Keploy ```bash curl --silent -O -L https://keploy.io/install.sh && source install.sh --oss ``` ### 2. Once done, you should see something like this: ```bash β–“β–ˆβ–ˆβ–“β–„ β–“β–“β–“β–“β–ˆβ–ˆβ–“β–ˆβ–“β–„ β–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–“β–’ β–€β–“β–“β–ˆβ–ˆβ–ˆβ–„ β–„β–„ β–„ β–Œ β–„β–Œβ–Œβ–“β–“β–ˆβ–ˆβ–ˆβ–ˆβ–„ β–ˆβ–ˆ β–“β–ˆβ–€ β–„β–Œβ–€β–„ β–“β–“β–Œβ–„ β–“β–ˆ β–„β–Œβ–“β–“β–Œβ–„ β–Œβ–Œ β–“ β–“β–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–Œβ–“β–“ β–ˆβ–ˆβ–“β–ˆβ–„ β–“β–ˆβ–„β–“β–“ β–β–ˆβ–Œ β–ˆβ–ˆ β–“β–ˆ β–ˆβ–Œ β–ˆβ–ˆ β–ˆβ–Œ β–ˆβ–“ β–“β–“β–“β–“β–€β–€β–€β–€β–“β–“β–“β–“β–“β–“β–Œ β–ˆβ–ˆ β–ˆβ–“ β–“β–Œβ–„β–„ β–β–ˆβ–“β–„β–“β–ˆβ–€ β–ˆβ–“β–ˆ β–€β–ˆβ–„β–„β–ˆβ–€ β–ˆβ–“β–ˆ β–“β–Œ β–β–ˆβ–Œ β–ˆβ–Œ β–“ OPEN SOURCE Available Commands: example Example to record and test via keploy config --generate generate the keploy configuration file record record the keploy testcases from the API calls test run the recorded testcases and execute assertions update Update Keploy Flags: --debug Run in debug mode -h, --help help for keploy -v, --version version for keploy Use "keploy [command] --help" for more information about a command. ``` πŸŽ‰ You have successfully installed **Keploy OSS on Linux**. ### Install Keploy OSS with Docker on Linux 1. Make sure Docker is installed on Linux. 2. Install Keploy ```bash curl --silent -O -L https://keploy.io/install.sh && source install.sh --oss ``` πŸŽ‰ You have successfully set up **Keploy OSS on Linux** using **Docker**. :::info Keploy does not natively support macOS. You can run it using **Lima** or **Docker**. ::: ### Install Keploy OSS with Lima 1. Check if Lima is installed. If yes, skip to step 6. 2. Install Lima ```bash brew install lima ``` 3. Create a Debian instance ```bash limactl create template://debian-12 ``` 4. Start the instance ```bash limactl start debian-12 ``` 5. Enter the Linux shell ```bash limactl shell debian-12 ``` 6. Install Keploy inside Lima ```bash curl --silent -O -L https://keploy.io/install.sh && source install.sh --oss ``` πŸŽ‰ You have successfully set up **Keploy OSS on macOS** using **Lima**. ### Install Keploy OSS with Docker on macOS 1. Make sure Docker Desktop is running on macOS. 2. Install Keploy ```bash curl --silent -O -L https://keploy.io/install.sh && source install.sh --oss ``` πŸŽ‰ You have successfully set up **Keploy OSS on macOS** using **Docker**. :::info You can run Keploy using **WSL** or **Docker** on Windows. ::: ### Install Keploy OSS with WSL 1. Enable WSL ```shell wsl --install -d ``` πŸ‘‰ We recommend **Ubuntu-22.04**. 2. Install Keploy inside WSL ```shell curl --silent -O -L https://keploy.io/install.sh && source install.sh --oss ``` πŸŽ‰ You have successfully set up **Keploy OSS on Windows** using **WSL**. ### Install Keploy OSS with Docker on Windows 1. Make sure Docker Desktop is running on Windows. 2. Install Keploy ```bash curl --silent -O -L https://keploy.io/install.sh && source install.sh --oss ``` πŸŽ‰ You have successfully set up **Keploy OSS on Windows** using **Docker**.