Skip to content

Commit

Permalink
chore:updated the alias (#287)
Browse files Browse the repository at this point in the history
Signed-off-by: Pranshu Srivastava <pranshu@Pranshus-MacBook-Air-2.local>
Co-authored-by: Pranshu Srivastava <pranshu@Pranshus-MacBook-Air-2.local>
  • Loading branch information
PranshuSrivastava and Pranshu Srivastava authored Dec 20, 2023
1 parent 59a2a65 commit 35dedb3
Show file tree
Hide file tree
Showing 11 changed files with 170 additions and 171 deletions.
7 changes: 3 additions & 4 deletions versioned_docs/version-2.0.0/keploy-explained/dev-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,15 +135,14 @@ docker build -t <nameOfImage> .
#### Create Alias:
```shell
alias keployV2='sudo docker run --name keploy-ebpf -p 16789:16789 --network keploy-network --privileged --pid=host -it -v "$(pwd)":/files -v /sys/fs/cgroup:/sys/fs/cgroup -v /sys/kernel/debug:/sys/kernel/debug -v /sys/fs/bpf:/sys/fs/bpf -v /var/run/docker.sock:/var/run/docker.sock --rm <nameOfImage>'
```
````shell
alias keployV2='sudo docker run --name keploy-v2 -p 16789:16789 --privileged --pid=host -it -v "$(pwd)":/files -v /sys/fs/cgroup:/sys/fs/cgroup -v /sys/kernel/debug:/sys/kernel/debug -v /sys/fs/bpf:/sys/fs/bpf -v /var/run/docker.sock:/var/run/docker.sock -v '"$HOME"'/.keploy-config:/root/.keploy-config -v '"$HOME"'/.keploy:/root/.keploy --rm <nameOfImage>'
#### Capture Test Cases:
```shell
keployV2 record -c "docker run -p 8080:8080 --name <containerName> --network keploy-network --rm <imageName>"" --containerName <containerName>
```
````

#### Running Test Cases:

Expand Down
44 changes: 22 additions & 22 deletions versioned_docs/version-2.0.0/quickstart/go-gin-mongo.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ go mod download
Depending on your OS, choose your adventure:

- <details>
<summary><img src="/docs/img/os/linux.png" alt="Linux" width="3%" /> Linux or <img src="/docs/img/os/windows.png" alt="Windows" width="3%" /> Windows</summary>
<summary><img src="/docs/img/os/linux.png" alt="Linux" width="3%" /> Linux or <img src="/docs/img/os/windows.png" alt="Windows" width="3%" /> Windows</summary>

Alright, let's equip ourselves with the **latest Keploy binary**:

Expand All @@ -49,16 +49,16 @@ Depending on your OS, choose your adventure:

If everything goes right, your screen should look a bit like this:

<img src="/docs/img/code-snippets/install-keploy-logs.png" alt="Test Case Generator" width="50%" />
<img src="/docs/img/code-snippets/install-keploy-logs.png" alt="Test Case Generator" width="50%" />

Moving on...
<details>
<summary style={{ fontWeight: 'bold', fontSize: '1.17em', marginLeft: '0.5em' }}> Run App with <img src="/docs/img/os/docker.png" alt="Docker Container" width="3%" /> Docker </summary>
<details>
<summary style={{ fontWeight: 'bold', fontSize: '1.17em', marginLeft: '0.5em' }}> Run App with <img src="/docs/img/os/docker.png" alt="Docker Container" width="3%" /> Docker </summary>

#### Add alias for Keploy:

```bash
alias keploy='sudo docker run --pull always --name keploy-v2 -p 16789:16789 --privileged --pid=host -it -v "$(pwd)":/files -v /sys/fs/cgroup:/sys/fs/cgroup -v /sys/kernel/debug:/sys/kernel/debug -v /sys/fs/bpf:/sys/fs/bpf -v /var/run/docker.sock:/var/run/docker.sock --rm ghcr.io/keploy/keploy'
alias keploy='sudo docker run --pull always --name keploy-v2 -p 16789:16789 --privileged --pid=host -it -v "$(pwd)":/files -v /sys/fs/cgroup:/sys/fs/cgroup -v /sys/kernel/debug:/sys/kernel/debug -v /sys/fs/bpf:/sys/fs/bpf -v /var/run/docker.sock:/var/run/docker.sock -v '"$HOME"'/.keploy-config:/root/.keploy-config -v '"$HOME"'/.keploy:/root/.keploy --rm ghcr.io/keploy/keploy'
```

### Lights, Camera, Record! πŸŽ₯
Expand All @@ -74,8 +74,8 @@ Depending on your OS, choose your adventure:

Getting logs like this? Perfect! πŸ‘Œ

<img src="/docs/img/code-snippets/keploy-record-docker.png" alt="Keploy Record Test case" width="100%" />
<img src="/docs/img/code-snippets/keploy-record-docker2.png" alt="Keploy record mocks" width="100%" />
<img src="/docs/img/code-snippets/keploy-record-docker.png" alt="Keploy Record Test case" width="100%" />
<img src="/docs/img/code-snippets/keploy-record-docker2.png" alt="Keploy record mocks" width="100%" />

πŸ”₯ Challenge time! Generate some test cases. How? Just **make some API calls**. Postman, Hoppscotch or even curl - take your pick!

Expand Down Expand Up @@ -261,11 +261,11 @@ Depending on your OS, choose your adventure:

Happy coding! βœ¨πŸ‘©β€πŸ’»πŸ‘¨β€πŸ’»βœ¨

</details>
<br/>
</details>
<br/>

<details>
<summary style={{ fontWeight: 'bold', fontSize: '1.17em', marginLeft: '0.5em' }}>Run App on 🐧 Linux </summary>
<details>
<summary style={{ fontWeight: 'bold', fontSize: '1.17em', marginLeft: '0.5em' }}>Run App on 🐧 Linux </summary>

We'll be running our sample application right on Linux, but just to make things a tad more thrilling, we'll have the database (mongoDB) chill on Docker. Ready? Let's get the party started!πŸŽ‰
First things first, update the MongoDB URL to `localhost:27017` on **line 21** of our trusty `main.go` file.
Expand All @@ -291,8 +291,8 @@ Depending on your OS, choose your adventure:
Keep an eye out for the `-c `flag! It's the command charm to run the app. Whether you're using `go run main.go handler.go` or the binary path like `./test-app-url-shortener`, it's your call.
If you're seeing logs that resemble the ones below, you're on the right track:

<img src="/docs/img/code-snippets/keploy-record-docker.png" alt="Keploy Record Test case" width="100%" />
<img src="/docs/img/code-snippets/keploy-record-docker2.png" alt="Keploy record mocks" width="100%" />
<img src="/docs/img/code-snippets/keploy-record-docker.png" alt="Keploy Record Test case" width="100%" />
<img src="/docs/img/code-snippets/keploy-record-docker2.png" alt="Keploy record mocks" width="100%" />

Alright, magician! With the app alive and kicking, let's weave some test cases. The spell? Making some API calls! Postman, Hoppscotch, or the classic curl - pick your wand.

Expand Down Expand Up @@ -470,14 +470,14 @@ Depending on your OS, choose your adventure:
Congrats on the journey so far! You've seen Keploy's power, flexed your coding muscles, and had a bit of fun too! Now, go out there and keep exploring, innovating, and creating! Remember, with the right tools and a sprinkle of fun, anything's possible. πŸ˜ŠπŸš€

Happy coding! βœ¨πŸ‘©β€πŸ’»πŸ‘¨β€πŸ’»βœ¨
</details>
</details>

</details>
</details>

<br/>
<br/>

- <details>
<summary><img src="/docs/img/os/macos.png" alt="MacOS" width="3%" /> MacOs </summary>
- <details>
<summary><img src="/docs/img/os/macos.png" alt="MacOS" width="3%" /> MacOs </summary>

Dive straight in, but first, give **Colima** a gentle nudge with (`colima start`). Let's make sure it's awake and ready for action!

Expand All @@ -486,7 +486,7 @@ Depending on your OS, choose your adventure:
For the sake of convenience (and a bit of Mac magic πŸͺ„), let's set up a shortcut for Keploy:

```bash
alias keploy='sudo docker run --pull always --name keploy-v2 -p 16789:16789 --privileged --pid=host -it -v "$(pwd)":/files -v /sys/fs/cgroup:/sys/fs/cgroup -v /sys/kernel/debug:/sys/kernel/debug -v /sys/fs/bpf:/sys/fs/bpf -v /var/run/docker.sock:/var/run/docker.sock --rm ghcr.io/keploy/keploy'
alias keploy='sudo docker run --pull always --name keploy-v2 -p 16789:16789 --privileged --pid=host -it -v "$(pwd)":/files -v /sys/fs/cgroup:/sys/fs/cgroup -v /sys/kernel/debug:/sys/kernel/debug -v /sys/fs/bpf:/sys/fs/bpf -v /var/run/docker.sock:/var/run/docker.sock -v '"$HOME"'/.keploy-config:/root/.keploy-config -v '"$HOME"'/.keploy:/root/.keploy --rm ghcr.io/keploy/keploy'
```

### Lights, Camera, Record! πŸŽ₯
Expand All @@ -502,8 +502,8 @@ Depending on your OS, choose your adventure:

Getting logs like this? Perfect! πŸ‘Œ

<img src="/docs/img/code-snippets/keploy-record-docker.png" alt="Keploy Record Test case" width="100%" />
<img src="/docs/img/code-snippets/keploy-record-docker2.png" alt="Keploy record mocks" width="100%" />
<img src="/docs/img/code-snippets/keploy-record-docker.png" alt="Keploy Record Test case" width="100%" />
<img src="/docs/img/code-snippets/keploy-record-docker2.png" alt="Keploy record mocks" width="100%" />

πŸ”₯ Challenge time! Generate some test cases. How? Just **make some API calls**. Postman, Hoppscotch or even curl - take your pick!

Expand Down Expand Up @@ -688,4 +688,4 @@ Depending on your OS, choose your adventure:
Congrats on the journey so far! You've seen Keploy's power, flexed your coding muscles, and had a bit of fun too! Now, go out there and keep exploring, innovating, and creating! Remember, with the right tools and a sprinkle of fun, anything's possible. πŸ˜ŠπŸš€

Happy coding! βœ¨πŸ‘©β€πŸ’»πŸ‘¨β€πŸ’»βœ¨
</details>
</details>
32 changes: 16 additions & 16 deletions versioned_docs/version-2.0.0/quickstart/go-gin-redis.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ docker build -t gin-app:1.0 .
Depending on your OS, choose your adventure:

- <details>
<summary><img src="/docs/img/os/linux.png" alt="Linux" width="3%" /> Linux or <img src="/docs/img/os/windows.png" alt="Windows" width="3%" /> Windows</summary>
<summary><img src="/docs/img/os/linux.png" alt="Linux" width="3%" /> Linux or <img src="/docs/img/os/windows.png" alt="Windows" width="3%" /> Windows</summary>

Alright, let's equip ourselves with the **latest Keploy binary**:

Expand All @@ -67,16 +67,16 @@ Depending on your OS, choose your adventure:

If everything goes right, your screen should look a bit like this:

<img src="/docs/img/code-snippets/install-keploy-logs.png" alt="Test Case Generator" width="50%" />
<img src="/docs/img/code-snippets/install-keploy-logs.png" alt="Test Case Generator" width="50%" />

Moving on...
<details>
<summary style={{ fontWeight: 'bold', fontSize: '1.17em', marginLeft: '0.5em' }}> Run App with <img src="/docs/img/os/docker.png" alt="Docker Container" width="3%" /> Docker </summary>
<details>
<summary style={{ fontWeight: 'bold', fontSize: '1.17em', marginLeft: '0.5em' }}> Run App with <img src="/docs/img/os/docker.png" alt="Docker Container" width="3%" /> Docker </summary>

#### Add alias for Keploy:

```bash
alias keploy='sudo docker run --pull always --name keploy-v2 -p 16789:16789 --privileged --pid=host -it -v "$(pwd)":/files -v /sys/fs/cgroup:/sys/fs/cgroup -v /sys/kernel/debug:/sys/kernel/debug -v /sys/fs/bpf:/sys/fs/bpf -v /var/run/docker.sock:/var/run/docker.sock --rm ghcr.io/keploy/keploy'
alias keploy='sudo docker run --pull always --name keploy-v2 -p 16789:16789 --privileged --pid=host -it -v "$(pwd)":/files -v /sys/fs/cgroup:/sys/fs/cgroup -v /sys/kernel/debug:/sys/kernel/debug -v /sys/fs/bpf:/sys/fs/bpf -v /var/run/docker.sock:/var/run/docker.sock -v '"$HOME"'/.keploy-config:/root/.keploy-config -v '"$HOME"'/.keploy:/root/.keploy --rm ghcr.io/keploy/keploy'
```

### Lights, Camera, Record! πŸŽ₯
Expand Down Expand Up @@ -254,11 +254,11 @@ Depending on your OS, choose your adventure:

Happy coding! βœ¨πŸ‘©β€πŸ’»πŸ‘¨β€πŸ’»βœ¨

</details>
<br/>
</details>
<br/>

<details>
<summary style={{ fontWeight: 'bold', fontSize: '1.17em', marginLeft: '0.5em' }}>Run App on 🐧 Linux </summary>
<details>
<summary style={{ fontWeight: 'bold', fontSize: '1.17em', marginLeft: '0.5em' }}>Run App on 🐧 Linux </summary>

We'll be running our sample application right on Linux, but just to make things a tad more thrilling, we'll have the database (Redis) chill on Docker. Ready? Let's get the party started!πŸŽ‰

Expand Down Expand Up @@ -447,14 +447,14 @@ Depending on your OS, choose your adventure:
Congrats on the journey so far! You've seen Keploy's power, flexed your coding muscles, and had a bit of fun too! Now, go out there and keep exploring, innovating, and creating! Remember, with the right tools and a sprinkle of fun, anything's possible. πŸ˜ŠπŸš€

Happy coding! βœ¨πŸ‘©β€πŸ’»πŸ‘¨β€πŸ’»βœ¨
</details>
</details>

</details>
</details>

<br/>
<br/>

- <details>
<summary><img src="/docs/img/os/macos.png" alt="MacOS" width="3%" /> MacOs </summary>
- <details>
<summary><img src="/docs/img/os/macos.png" alt="MacOS" width="3%" /> MacOs </summary>

Dive straight in, but first, give **Colima** a gentle nudge with (`colima start`). Let's make sure it's awake and ready for action!

Expand All @@ -463,7 +463,7 @@ Depending on your OS, choose your adventure:
For the sake of convenience (and a bit of Mac magic πŸͺ„), let's set up a shortcut for Keploy:

```bash
alias keploy='sudo docker run --pull always --name keploy-v2 -p 16789:16789 --privileged --pid=host -it -v "$(pwd)":/files -v /sys/fs/cgroup:/sys/fs/cgroup -v /sys/kernel/debug:/sys/kernel/debug -v /sys/fs/bpf:/sys/fs/bpf -v /var/run/docker.sock:/var/run/docker.sock --rm ghcr.io/keploy/keploy'
alias keploy='sudo docker run --pull always --name keploy-v2 -p 16789:16789 --privileged --pid=host -it -v "$(pwd)":/files -v /sys/fs/cgroup:/sys/fs/cgroup -v /sys/kernel/debug:/sys/kernel/debug -v /sys/fs/bpf:/sys/fs/bpf -v /var/run/docker.sock:/var/run/docker.sock -v '"$HOME"'/.keploy-config:/root/.keploy-config -v '"$HOME"'/.keploy:/root/.keploy --rm ghcr.io/keploy/keploy'
```

### Lights, Camera, Record! πŸŽ₯
Expand Down Expand Up @@ -641,4 +641,4 @@ Depending on your OS, choose your adventure:

Happy coding! βœ¨πŸ‘©β€πŸ’»πŸ‘¨β€πŸ’»βœ¨

</details>
</details>
40 changes: 20 additions & 20 deletions versioned_docs/version-2.0.0/quickstart/go-mux-sql.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@ go mod download
Depending on your OS, choose your adventure:

- <details>
<summary><img src="/docs/img/os/linux.png" alt="Linux" width="3%" /> Linux or <img src="/docs/img/os/windows.png" alt="Windows" width="3%" /> Windows</summary>
<summary><img src="/docs/img/os/linux.png" alt="Linux" width="3%" /> Linux or <img src="/docs/img/os/windows.png" alt="Windows" width="3%" /> Windows</summary>
<summary><img src="/docs/img/os/linux.png" alt="Linux" width="3%" /> Linux or <img src="/docs/img/os/windows.png" alt="Windows" width="3%" /> Windows</summary>
<summary><img src="/docs/img/os/linux.png" alt="Linux" width="3%" /> Linux or <img src="/docs/img/os/windows.png" alt="Windows" width="3%" /> Windows</summary>

Alright, let's equip ourselves with the **latest Keploy binary**:

Expand All @@ -54,18 +54,18 @@ Depending on your OS, choose your adventure:

If everything goes right, your screen should look a bit like this:

<img src="/docs/img/code-snippets/install-keploy-logs.png" alt="Test Case Generator" width="50%" />
<img src="/docs/img/code-snippets/install-keploy-logs.png" alt="Test Case Generator" width="50%" />
<img src="/docs/img/code-snippets/install-keploy-logs.png" alt="Test Case Generator" width="50%" />
<img src="/docs/img/code-snippets/install-keploy-logs.png" alt="Test Case Generator" width="50%" />

Moving on...
<details>
<summary style={{ fontWeight: 'bold', fontSize: '1.17em', marginLeft: '0.5em' }}> Run App with <img src="/docs/img/os/docker.png" alt="Docker Container" width="3%" /> Docker </summary>
<summary style={{ fontWeight: 'bold', fontSize: '1.17em', marginLeft: '0.5em' }}> Run App with <img src="/docs/img/os/docker.png" alt="Docker Container" width="3%" /> Docker </summary>
<details>
<summary style={{ fontWeight: 'bold', fontSize: '1.17em', marginLeft: '0.5em' }}> Run App with <img src="/docs/img/os/docker.png" alt="Docker Container" width="3%" /> Docker </summary>
<summary style={{ fontWeight: 'bold', fontSize: '1.17em', marginLeft: '0.5em' }}> Run App with <img src="/docs/img/os/docker.png" alt="Docker Container" width="3%" /> Docker </summary>

#### Add alias for Keploy:

```bash
alias keploy='sudo docker run --pull always --name keploy-v2 -p 16789:16789 --privileged --pid=host -it -v "$(pwd)":/files -v /sys/fs/cgroup:/sys/fs/cgroup -v /sys/kernel/debug:/sys/kernel/debug -v /sys/fs/bpf:/sys/fs/bpf -v /var/run/docker.sock:/var/run/docker.sock --rm ghcr.io/keploy/keploy'
alias keploy='sudo docker run --pull always --name keploy-v2 -p 16789:16789 --privileged --pid=host -it -v "$(pwd)":/files -v /sys/fs/cgroup:/sys/fs/cgroup -v /sys/kernel/debug:/sys/kernel/debug -v /sys/fs/bpf:/sys/fs/bpf -v /var/run/docker.sock:/var/run/docker.sock -v '"$HOME"'/.keploy-config:/root/.keploy-config -v '"$HOME"'/.keploy:/root/.keploy --rm ghcr.io/keploy/keploy'
```

### Lights, Camera, Record! πŸŽ₯
Expand Down Expand Up @@ -228,11 +228,11 @@ Depending on your OS, choose your adventure:

Happy coding! βœ¨πŸ‘©β€πŸ’»πŸ‘¨β€πŸ’»βœ¨

</details>
<br/>
</details>
<br/>

<details>
<summary style={{ fontWeight: 'bold', fontSize: '1.17em', marginLeft: '0.5em' }}>Run App on 🐧 Linux </summary>
<details>
<summary style={{ fontWeight: 'bold', fontSize: '1.17em', marginLeft: '0.5em' }}>Run App on 🐧 Linux </summary>

We'll be running our sample application right on Linux, but just to make things a tad more thrilling, we'll have the database (mongoDB) chill on Docker. Ready? Let's get the party started!πŸŽ‰

Expand Down Expand Up @@ -409,15 +409,15 @@ Depending on your OS, choose your adventure:
Congrats on the journey so far! You've seen Keploy's power, flexed your coding muscles, and had a bit of fun too! Now, go out there and keep exploring, innovating, and creating! Remember, with the right tools and a sprinkle of fun, anything's possible. πŸ˜ŠπŸš€

Happy coding! βœ¨πŸ‘©β€πŸ’»πŸ‘¨β€πŸ’»βœ¨
</details>
</details>

</details>
</details>

<br/>
<br/>

- <details>
<summary><img src="/docs/img/os/macos.png" alt="MacOS" width="3%" /> MacOs </summary>
<summary><img src="/docs/img/os/macos.png" alt="MacOS" width="3%" /> MacOs </summary>
- <details>
<summary><img src="/docs/img/os/macos.png" alt="MacOS" width="3%" /> MacOs </summary>
<summary><img src="/docs/img/os/macos.png" alt="MacOS" width="3%" /> MacOs </summary>

Dive straight in, but first, give **Colima** a gentle nudge with (`colima start`). Let's make sure it's awake and ready for action!

Expand All @@ -426,7 +426,7 @@ Depending on your OS, choose your adventure:
For the sake of convenience (and a bit of Mac magic πŸͺ„), let's set up a shortcut for Keploy:

```bash
alias keploy='sudo docker run --pull always --name keploy-v2 -p 16789:16789 --privileged --pid=host -it -v "$(pwd)":/files -v /sys/fs/cgroup:/sys/fs/cgroup -v /sys/kernel/debug:/sys/kernel/debug -v /sys/fs/bpf:/sys/fs/bpf -v /var/run/docker.sock:/var/run/docker.sock --rm ghcr.io/keploy/keploy'
alias keploy='sudo docker run --pull always --name keploy-v2 -p 16789:16789 --privileged --pid=host -it -v "$(pwd)":/files -v /sys/fs/cgroup:/sys/fs/cgroup -v /sys/kernel/debug:/sys/kernel/debug -v /sys/fs/bpf:/sys/fs/bpf -v /var/run/docker.sock:/var/run/docker.sock -v '"$HOME"'/.keploy-config:/root/.keploy-config -v '"$HOME"'/.keploy:/root/.keploy --rm ghcr.io/keploy/keploy'
```

### Lights, Camera, Record! πŸŽ₯
Expand Down Expand Up @@ -593,4 +593,4 @@ Depending on your OS, choose your adventure:
Congrats on the journey so far! You've seen Keploy's power, flexed your coding muscles, and had a bit of fun too! Now, go out there and keep exploring, innovating, and creating! Remember, with the right tools and a sprinkle of fun, anything's possible. πŸ˜ŠπŸš€

Happy coding! βœ¨πŸ‘©β€πŸ’»πŸ‘¨β€πŸ’»βœ¨
</details>
</details>
Loading

0 comments on commit 35dedb3

Please sign in to comment.