Skip to content

Added documentation for the example command #274

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
nehagup merged 8 commits into from
Dec 7, 2023
Merged

Added documentation for the example command #274

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
31b118d
Added documentation for the `example` command
jaimin001 Dec 4, 2023
57d1464
fixed the usage command at display when run locally
jaimin001 Dec 5, 2023
af7950a
fix: fixed typo in samples-bunjs (#273)
officialasishkumar Dec 5, 2023
92ca9bd
updated a line for better interpretation
jaimin001 Dec 6, 2023
b275234
Merge branch 'main' into main
jaimin001 Dec 6, 2023
40cfc9d
updated : with - for consistency
jaimin001 Dec 6, 2023
c7cc889
Merge branch 'main' into main
jaimin001 Dec 6, 2023
85908d8
Merge branch 'main' into main
nehagup Dec 7, 2023
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
15 changes: 15 additions & 0 deletions versioned_docs/version-2.0.0/running-keploy/cli-commands.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ Keploy CLI has the following <b> commands </b>:
- [record](#record)
- [test](#test)
- [generate-config](#generate-config)
- [example](#example)

### Usage

Expand Down Expand Up @@ -203,3 +204,17 @@ 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.

<b> Usage: </b>

```bash
keploy example [flags]
```

<b> Available Flags: </b>

- `--customSetup` - Displays commands tailored for custom user-defined setups.