From 31b118d1842e3b18ead4a9eeaf013c8196ba8a20 Mon Sep 17 00:00:00 2001 From: Jaimin Gajjar <82583076+jaimin001@users.noreply.github.com> Date: Mon, 4 Dec 2023 19:52:40 +0530 Subject: [PATCH 1/5] Added documentation for the `example` command Signed-off-by: Jaimin Gajjar --- .../version-2.0.0/running-keploy/cli-commands.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/versioned_docs/version-2.0.0/running-keploy/cli-commands.md b/versioned_docs/version-2.0.0/running-keploy/cli-commands.md index 9399d61e2..2250acd6d 100755 --- a/versioned_docs/version-2.0.0/running-keploy/cli-commands.md +++ b/versioned_docs/version-2.0.0/running-keploy/cli-commands.md @@ -21,6 +21,7 @@ Keploy CLI has the following commands : - [record](#record) - [test](#test) - [generate-config](#generate-config) +- [example](#example) ### Usage @@ -203,3 +204,16 @@ keploy generate-config [flags] ``` In the above command, `config-dir` is the directory in the CWD where the Keploy configuration file `keploy-config.yaml` is to be stored. + +## [example](#example) + +The `example` command in Keploy is designed to illustrate the usage of Keploy in various scenarios, showing its capabilities with different types of applications and setups. Below are examples for using Keploy with Golang, Node.js, Java, and Docker applications. + + Usage: + ```bash + keploy example [flags] + ``` + + Available Flags: + +- `--customSetup`: Displays commands tailored for custom setups. From 57d14641fa57ad1ef256acf01d024f85670e1839 Mon Sep 17 00:00:00 2001 From: Jaimin Gajjar <82583076+jaimin001@users.noreply.github.com> Date: Tue, 5 Dec 2023 20:47:14 +0530 Subject: [PATCH 2/5] fixed the usage command at display when run locally Signed-off-by: Jaimin Gajjar <82583076+jaimin001@users.noreply.github.com> Signed-off-by: Jaimin Gajjar --- versioned_docs/version-2.0.0/running-keploy/cli-commands.md | 1 + 1 file changed, 1 insertion(+) diff --git a/versioned_docs/version-2.0.0/running-keploy/cli-commands.md b/versioned_docs/version-2.0.0/running-keploy/cli-commands.md index 2250acd6d..e2f38b67d 100755 --- a/versioned_docs/version-2.0.0/running-keploy/cli-commands.md +++ b/versioned_docs/version-2.0.0/running-keploy/cli-commands.md @@ -210,6 +210,7 @@ keploy generate-config [flags] The `example` command in Keploy is designed to illustrate the usage of Keploy in various scenarios, showing its capabilities with different types of applications and setups. Below are examples for using Keploy with Golang, Node.js, Java, and Docker applications. Usage: + ```bash keploy example [flags] ``` From af7950a8e079feafa7a07c916360956059f32786 Mon Sep 17 00:00:00 2001 From: Asish Kumar <87874775+officialasishkumar@users.noreply.github.com> Date: Tue, 5 Dec 2023 11:36:53 +0530 Subject: [PATCH 3/5] fix: fixed typo in samples-bunjs (#273) Signed-off-by: Asish Kumar Signed-off-by: Jaimin Gajjar --- versioned_docs/version-2.0.0/quickstart/samples-bunjs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/versioned_docs/version-2.0.0/quickstart/samples-bunjs.md b/versioned_docs/version-2.0.0/quickstart/samples-bunjs.md index 5cd683a11..7c26a53a8 100644 --- a/versioned_docs/version-2.0.0/quickstart/samples-bunjs.md +++ b/versioned_docs/version-2.0.0/quickstart/samples-bunjs.md @@ -92,7 +92,7 @@ sudo mkdir -p /usr/local/bin && sudo mv /tmp/keploy /usr/local/bin && keploy docker-compose up -d ``` -> **Since we have setup our sample-app natively, we need to update the mongoDB host on line 41, in `supabun.ts`, from `mongodb://mongoDb-bun:27017/keploy` to `mongodb://loacalhost:27017/keploy`.** +> **Since we have setup our sample-app natively, we need to update the mongoDB host on line 41, in `supabun.ts`, from `mongodb://mongoDb-bun:27017/keploy` to `mongodb://localhost:27017/keploy`.** ### Capture the testcases From 92ca9bdb12ba9318b15a816b75df6a196b2eddee Mon Sep 17 00:00:00 2001 From: Jaimin Gajjar Date: Wed, 6 Dec 2023 19:02:39 +0530 Subject: [PATCH 4/5] updated a line for better interpretation Signed-off-by: Jaimin Gajjar --- versioned_docs/version-2.0.0/running-keploy/cli-commands.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/versioned_docs/version-2.0.0/running-keploy/cli-commands.md b/versioned_docs/version-2.0.0/running-keploy/cli-commands.md index e2f38b67d..e7e7cb775 100755 --- a/versioned_docs/version-2.0.0/running-keploy/cli-commands.md +++ b/versioned_docs/version-2.0.0/running-keploy/cli-commands.md @@ -217,4 +217,4 @@ The `example` command in Keploy is designed to illustrate the usage of Keploy in Available Flags: -- `--customSetup`: Displays commands tailored for custom setups. +- `--customSetup`: Displays commands tailored for custom user-defined setups. From 40cfc9d7fcbc001fb3e1c948a3267b94b4085a4b Mon Sep 17 00:00:00 2001 From: Jaimin Gajjar Date: Wed, 6 Dec 2023 19:54:14 +0530 Subject: [PATCH 5/5] updated : with - for consistency Signed-off-by: Jaimin Gajjar --- versioned_docs/version-2.0.0/running-keploy/cli-commands.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/versioned_docs/version-2.0.0/running-keploy/cli-commands.md b/versioned_docs/version-2.0.0/running-keploy/cli-commands.md index e7e7cb775..e21770345 100755 --- a/versioned_docs/version-2.0.0/running-keploy/cli-commands.md +++ b/versioned_docs/version-2.0.0/running-keploy/cli-commands.md @@ -217,4 +217,4 @@ The `example` command in Keploy is designed to illustrate the usage of Keploy in Available Flags: -- `--customSetup`: Displays commands tailored for custom user-defined setups. +- `--customSetup` - Displays commands tailored for custom user-defined setups.