docs: update hrp cmd docs

This commit is contained in:
lilong.129
2025-04-24 22:31:03 +08:00
parent 9473345ec9
commit 03c0d6ee42
47 changed files with 587 additions and 117 deletions

View File

@@ -1,6 +1,6 @@
## hrp
Next-Generation API Testing Solution.
All-in-One Testing Framework for API, UI and Performance
### Synopsis
@@ -12,30 +12,52 @@ Next-Generation API Testing Solution.
██║ ██║ ██║ ██║ ██║ ██║ ██║╚██████╔╝██║ ╚████║██║ ╚████║███████╗██║ ██║
╚═╝ ╚═╝ ╚═╝ ╚═╝ ╚═╝ ╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═══╝╚═╝ ╚═══╝╚══════╝╚═╝ ╚═╝
HttpRunner is an open source API testing tool that supports HTTP(S)/HTTP2/WebSocket/RPC
network protocols, covering API testing, performance testing and digital experience
monitoring (DEM) test types. Enjoy! ✨ 🚀 ✨
HttpRunner: Enjoy your All-in-One Testing Solution ✨ 🚀 ✨
License: Apache-2.0
💡 Simple Yet Powerful
- Natural language driven test scenarios powered by LLM
- User-friendly SDK API with IDE auto-completion
- Intuitive GoTest/YAML/JSON/Text testcase format
📌 Comprehensive Testing Capabilities
- UI Automation: Android/iOS/Harmony/Browser
- API Testing: HTTP(S)/HTTP2/WebSocket/RPC
- Load Testing: run API testcase concurrently with boomer
🧩 High Scalability
- Plugin system for custom functions
- Distributed testing support
- Cross-platform: macOS/Linux/Windows
🛠 Easy Integration
- CI/CD friendly with JSON logs and HTML reports
- Rich ecosystem tools
Learn more:
Website: https://httprunner.com
Github: https://github.com/httprunner/httprunner
Copyright 2017 debugtalk
GitHub: https://github.com/httprunner/httprunner
Copyright © 2017-present debugtalk. Apache-2.0 License.
### Options
```
-h, --help help for hrp
-h, --help help for hrp
--log-json set log to json format (default colorized console)
-l, --log-level string set log level (default "INFO")
--venv string specify python3 venv path
```
### SEE ALSO
* [hrp boom](hrp_boom.md) - run load test with boomer
* [hrp adb](hrp_adb.md) - simple utils for android device management
* [hrp build](hrp_build.md) - build plugin for testing
* [hrp convert](hrp_convert.md) - convert multiple source format to HttpRunner JSON/YAML/gotest/pytest cases
* [hrp ios](hrp_ios.md) - simple utils for ios device management
* [hrp pytest](hrp_pytest.md) - run API test with pytest
* [hrp run](hrp_run.md) - run API test with go engine
* [hrp server](hrp_server.md) - start hrp server
* [hrp startproject](hrp_startproject.md) - create a scaffold project
* [hrp wiki](hrp_wiki.md) - visit https://httprunner.com
###### Auto generated by spf13/cobra on 9-Nov-2024
###### Auto generated by spf13/cobra on 24-Apr-2025

26
docs/cmd/hrp_adb.md Normal file
View File

@@ -0,0 +1,26 @@
## hrp adb
simple utils for android device management
### Options
```
-h, --help help for adb
```
### Options inherited from parent commands
```
--log-json set log to json format (default colorized console)
-l, --log-level string set log level (default "INFO")
--venv string specify python3 venv path
```
### SEE ALSO
* [hrp](hrp.md) - All-in-One Testing Framework for API, UI and Performance
* [hrp adb devices](hrp_adb_devices.md) - List all Android devices
* [hrp adb install](hrp_adb_install.md) - push package to the device and install them automatically
* [hrp adb screencap](hrp_adb_screencap.md) - Start android screen capture
###### Auto generated by spf13/cobra on 24-Apr-2025

View File

@@ -0,0 +1,27 @@
## hrp adb devices
List all Android devices
```
hrp adb devices [flags]
```
### Options
```
-h, --help help for devices
```
### Options inherited from parent commands
```
--log-json set log to json format (default colorized console)
-l, --log-level string set log level (default "INFO")
--venv string specify python3 venv path
```
### SEE ALSO
* [hrp adb](hrp_adb.md) - simple utils for android device management
###### Auto generated by spf13/cobra on 24-Apr-2025

View File

@@ -0,0 +1,31 @@
## hrp adb install
push package to the device and install them automatically
```
hrp adb install [flags] PACKAGE
```
### Options
```
-d, --downgrade allow version code downgrade (debuggable packages only)
-g, --grant grant all runtime permissions
-h, --help help for install
-r, --replace replace existing application
-s, --serial string filter by device's serial
```
### Options inherited from parent commands
```
--log-json set log to json format (default colorized console)
-l, --log-level string set log level (default "INFO")
--venv string specify python3 venv path
```
### SEE ALSO
* [hrp adb](hrp_adb.md) - simple utils for android device management
###### Auto generated by spf13/cobra on 24-Apr-2025

View File

@@ -0,0 +1,28 @@
## hrp adb screencap
Start android screen capture
```
hrp adb screencap [flags]
```
### Options
```
-h, --help help for screencap
-s, --serial string filter by device's serial
```
### Options inherited from parent commands
```
--log-json set log to json format (default colorized console)
-l, --log-level string set log level (default "INFO")
--venv string specify python3 venv path
```
### SEE ALSO
* [hrp adb](hrp_adb.md) - simple utils for android device management
###### Auto generated by spf13/cobra on 24-Apr-2025

View File

@@ -24,8 +24,16 @@ hrp build $path ... [flags]
-o, --output string funplugin product output path, default: cwd
```
### Options inherited from parent commands
```
--log-json set log to json format (default colorized console)
-l, --log-level string set log level (default "INFO")
--venv string specify python3 venv path
```
### SEE ALSO
* [hrp](hrp.md) - Next-Generation API Testing Solution.
* [hrp](hrp.md) - All-in-One Testing Framework for API, UI and Performance
###### Auto generated by spf13/cobra on 9-Nov-2024
###### Auto generated by spf13/cobra on 24-Apr-2025

View File

@@ -22,8 +22,16 @@ hrp convert $path... [flags]
--to-yaml convert to YAML case scripts
```
### Options inherited from parent commands
```
--log-json set log to json format (default colorized console)
-l, --log-level string set log level (default "INFO")
--venv string specify python3 venv path
```
### SEE ALSO
* [hrp](hrp.md) - Next-Generation API Testing Solution.
* [hrp](hrp.md) - All-in-One Testing Framework for API, UI and Performance
###### Auto generated by spf13/cobra on 9-Nov-2024
###### Auto generated by spf13/cobra on 24-Apr-2025

32
docs/cmd/hrp_ios.md Normal file
View File

@@ -0,0 +1,32 @@
## hrp ios
simple utils for ios device management
### Options
```
-h, --help help for ios
```
### Options inherited from parent commands
```
--log-json set log to json format (default colorized console)
-l, --log-level string set log level (default "INFO")
--venv string specify python3 venv path
```
### SEE ALSO
* [hrp](hrp.md) - All-in-One Testing Framework for API, UI and Performance
* [hrp ios apps](hrp_ios_apps.md) - List all iOS installed apps
* [hrp ios devices](hrp_ios_devices.md) - List all iOS devices
* [hrp ios install](hrp_ios_install.md) - push package to the device and install them automatically
* [hrp ios mount](hrp_ios_mount.md) - A brief description of your command
* [hrp ios ps](hrp_ios_ps.md) - show running processes
* [hrp ios reboot](hrp_ios_reboot.md) - reboot ios device
* [hrp ios tunnel](hrp_ios_tunnel.md) - tunnel start
* [hrp ios uninstall](hrp_ios_uninstall.md) - uninstall package automatically
* [hrp ios xctest](hrp_ios_xctest.md) - run xctest
###### Auto generated by spf13/cobra on 24-Apr-2025

29
docs/cmd/hrp_ios_apps.md Normal file
View File

@@ -0,0 +1,29 @@
## hrp ios apps
List all iOS installed apps
```
hrp ios apps [flags]
```
### Options
```
-h, --help help for apps
-t, --type string filter application type [user|system|internal|all] (default "user")
-u, --udid string specify device by udid
```
### Options inherited from parent commands
```
--log-json set log to json format (default colorized console)
-l, --log-level string set log level (default "INFO")
--venv string specify python3 venv path
```
### SEE ALSO
* [hrp ios](hrp_ios.md) - simple utils for ios device management
###### Auto generated by spf13/cobra on 24-Apr-2025

View File

@@ -0,0 +1,27 @@
## hrp ios devices
List all iOS devices
```
hrp ios devices [flags]
```
### Options
```
-h, --help help for devices
```
### Options inherited from parent commands
```
--log-json set log to json format (default colorized console)
-l, --log-level string set log level (default "INFO")
--venv string specify python3 venv path
```
### SEE ALSO
* [hrp ios](hrp_ios.md) - simple utils for ios device management
###### Auto generated by spf13/cobra on 24-Apr-2025

View File

@@ -0,0 +1,28 @@
## hrp ios install
push package to the device and install them automatically
```
hrp ios install [flags] PACKAGE
```
### Options
```
-h, --help help for install
-u, --udid string filter by device's serial
```
### Options inherited from parent commands
```
--log-json set log to json format (default colorized console)
-l, --log-level string set log level (default "INFO")
--venv string specify python3 venv path
```
### SEE ALSO
* [hrp ios](hrp_ios.md) - simple utils for ios device management
###### Auto generated by spf13/cobra on 24-Apr-2025

31
docs/cmd/hrp_ios_mount.md Normal file
View File

@@ -0,0 +1,31 @@
## hrp ios mount
A brief description of your command
```
hrp ios mount [flags]
```
### Options
```
-d, --dir string specify developer disk image directory (default "/Users/debugtalk/.devimages")
-h, --help help for mount
--list list developer disk images
--reset unmount developer disk images
-u, --udid string specify device by udid
```
### Options inherited from parent commands
```
--log-json set log to json format (default colorized console)
-l, --log-level string set log level (default "INFO")
--venv string specify python3 venv path
```
### SEE ALSO
* [hrp ios](hrp_ios.md) - simple utils for ios device management
###### Auto generated by spf13/cobra on 24-Apr-2025

29
docs/cmd/hrp_ios_ps.md Normal file
View File

@@ -0,0 +1,29 @@
## hrp ios ps
show running processes
```
hrp ios ps [flags]
```
### Options
```
-a, --all print all processes including system processes
-h, --help help for ps
-u, --udid string specify device by udid
```
### Options inherited from parent commands
```
--log-json set log to json format (default colorized console)
-l, --log-level string set log level (default "INFO")
--venv string specify python3 venv path
```
### SEE ALSO
* [hrp ios](hrp_ios.md) - simple utils for ios device management
###### Auto generated by spf13/cobra on 24-Apr-2025

View File

@@ -0,0 +1,28 @@
## hrp ios reboot
reboot ios device
```
hrp ios reboot [flags]
```
### Options
```
-h, --help help for reboot
-u, --udid string specify device by udid
```
### Options inherited from parent commands
```
--log-json set log to json format (default colorized console)
-l, --log-level string set log level (default "INFO")
--venv string specify python3 venv path
```
### SEE ALSO
* [hrp ios](hrp_ios.md) - simple utils for ios device management
###### Auto generated by spf13/cobra on 24-Apr-2025

View File

@@ -0,0 +1,27 @@
## hrp ios tunnel
tunnel start
```
hrp ios tunnel [flags]
```
### Options
```
-h, --help help for tunnel
```
### Options inherited from parent commands
```
--log-json set log to json format (default colorized console)
-l, --log-level string set log level (default "INFO")
--venv string specify python3 venv path
```
### SEE ALSO
* [hrp ios](hrp_ios.md) - simple utils for ios device management
###### Auto generated by spf13/cobra on 24-Apr-2025

View File

@@ -0,0 +1,29 @@
## hrp ios uninstall
uninstall package automatically
```
hrp ios uninstall [flags] PACKAGE
```
### Options
```
-b, --bundleId string bundleId to uninstall
-h, --help help for uninstall
-u, --udid string filter by device's serial
```
### Options inherited from parent commands
```
--log-json set log to json format (default colorized console)
-l, --log-level string set log level (default "INFO")
--venv string specify python3 venv path
```
### SEE ALSO
* [hrp ios](hrp_ios.md) - simple utils for ios device management
###### Auto generated by spf13/cobra on 24-Apr-2025

View File

@@ -0,0 +1,31 @@
## hrp ios xctest
run xctest
```
hrp ios xctest [flags]
```
### Options
```
-b, --bundleID string specify ios bundleID (default "com.gtf.wda.runner.xctrunner")
-h, --help help for xctest
-t, --testRunnerBundleID string specify ios testRunnerBundleID (default "com.gtf.wda.runner.xctrunner")
-u, --udid string specify ios device's UDID
-x, --xctestConfig string specify ios xctestConfig (default "GtfWdaRunner.xctest")
```
### Options inherited from parent commands
```
--log-json set log to json format (default colorized console)
-l, --log-level string set log level (default "INFO")
--venv string specify python3 venv path
```
### SEE ALSO
* [hrp ios](hrp_ios.md) - simple utils for ios device management
###### Auto generated by spf13/cobra on 24-Apr-2025

View File

@@ -12,8 +12,16 @@ hrp pytest $path ... [flags]
-h, --help help for pytest
```
### Options inherited from parent commands
```
--log-json set log to json format (default colorized console)
-l, --log-level string set log level (default "INFO")
--venv string specify python3 venv path
```
### SEE ALSO
* [hrp](hrp.md) - Next-Generation API Testing Solution.
* [hrp](hrp.md) - All-in-One Testing Framework for API, UI and Performance
###### Auto generated by spf13/cobra on 9-Nov-2024
###### Auto generated by spf13/cobra on 24-Apr-2025

View File

@@ -32,8 +32,16 @@ hrp run $path... [flags]
-s, --save-tests save tests summary
```
### Options inherited from parent commands
```
--log-json set log to json format (default colorized console)
-l, --log-level string set log level (default "INFO")
--venv string specify python3 venv path
```
### SEE ALSO
* [hrp](hrp.md) - Next-Generation API Testing Solution.
* [hrp](hrp.md) - All-in-One Testing Framework for API, UI and Performance
###### Auto generated by spf13/cobra on 9-Nov-2024
###### Auto generated by spf13/cobra on 24-Apr-2025

View File

@@ -4,7 +4,7 @@ start hrp server
### Synopsis
start hrp server. exec automation by http
start hrp server, call httprunner by HTTP
```
hrp server start [flags]
@@ -13,12 +13,21 @@ hrp server start [flags]
### Options
```
-h, --help help for server
-p, --port int Port to run the server on (default 8082)
-h, --help help for server
-c, --mcp-config string path to the MCP config file (default "$HOME/.hrp/mcp.json")
-p, --port int port to run the server on (default 8082)
```
### Options inherited from parent commands
```
--log-json set log to json format (default colorized console)
-l, --log-level string set log level (default "INFO")
--venv string specify python3 venv path
```
### SEE ALSO
* [hrp](hrp.md) - Next-Generation API Testing Solution.
* [hrp](hrp.md) - All-in-One Testing Framework for API, UI and Performance
###### Auto generated by spf13/cobra on 9-Nov-2024
###### Auto generated by spf13/cobra on 24-Apr-2025

View File

@@ -17,8 +17,16 @@ hrp startproject $project_name [flags]
--py generate hashicorp python plugin (default true)
```
### Options inherited from parent commands
```
--log-json set log to json format (default colorized console)
-l, --log-level string set log level (default "INFO")
--venv string specify python3 venv path
```
### SEE ALSO
* [hrp](hrp.md) - Next-Generation API Testing Solution.
* [hrp](hrp.md) - All-in-One Testing Framework for API, UI and Performance
###### Auto generated by spf13/cobra on 9-Nov-2024
###### Auto generated by spf13/cobra on 24-Apr-2025

View File

@@ -12,8 +12,16 @@ hrp wiki [flags]
-h, --help help for wiki
```
### Options inherited from parent commands
```
--log-json set log to json format (default colorized console)
-l, --log-level string set log level (default "INFO")
--venv string specify python3 venv path
```
### SEE ALSO
* [hrp](hrp.md) - Next-Generation API Testing Solution.
* [hrp](hrp.md) - All-in-One Testing Framework for API, UI and Performance
###### Auto generated by spf13/cobra on 9-Nov-2024
###### Auto generated by spf13/cobra on 24-Apr-2025