GithubBackup/httprunner
1
0
Fork 0
mirror of https://github.com/httprunner/httprunner.git synced 2026-09-05 23:51:25 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: update cmd docs

Browse Source
This commit is contained in:
lilong.129
2025-06-09 00:06:23 +08:00
parent cf360c8c46
commit a91a10ac13
27 changed files with 88 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/cmd/hrp.md
+2 -1
View File
@@ -57,9 +57,10 @@ Copyright © 2017-present debugtalk. Apache-2.0 License.
* [hrp mcp-server](hrp_mcp-server.md) - Start MCP server for UI automation * [hrp mcp-server](hrp_mcp-server.md) - Start MCP server for UI automation
* [hrp mcphost](hrp_mcphost.md) - Start a chat session to interact with MCP tools * [hrp mcphost](hrp_mcphost.md) - Start a chat session to interact with MCP tools
* [hrp pytest](hrp_pytest.md) - Run API test with pytest * [hrp pytest](hrp_pytest.md) - Run API test with pytest
* [hrp report](hrp_report.md) - Generate HTML report from test results
* [hrp run](hrp_run.md) - Run API test with go engine * [hrp run](hrp_run.md) - Run API test with go engine
* [hrp server](hrp_server.md) - Start hrp server * [hrp server](hrp_server.md) - Start hrp server
* [hrp startproject](hrp_startproject.md) - Create a scaffold project * [hrp startproject](hrp_startproject.md) - Create a scaffold project
* [hrp wiki](hrp_wiki.md) - visit https://httprunner.com * [hrp wiki](hrp_wiki.md) - visit https://httprunner.com
###### Auto generated by spf13/cobra on 26-May-2025 ###### Auto generated by spf13/cobra on 8-Jun-2025
docs/cmd/hrp_adb.md
+1 -1
View File
@@ -23,4 +23,4 @@ simple utils for android device management
* [hrp adb install](hrp_adb_install.md) - push package to the device and install them automatically * [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 * [hrp adb screencap](hrp_adb_screencap.md) - Start android screen capture
###### Auto generated by spf13/cobra on 26-May-2025 ###### Auto generated by spf13/cobra on 8-Jun-2025
docs/cmd/hrp_adb_devices.md
+1 -1
View File
@@ -24,4 +24,4 @@ hrp adb devices [flags]
* [hrp adb](hrp_adb.md) - simple utils for android device management * [hrp adb](hrp_adb.md) - simple utils for android device management
###### Auto generated by spf13/cobra on 26-May-2025 ###### Auto generated by spf13/cobra on 8-Jun-2025
docs/cmd/hrp_adb_install.md
+1 -1
View File
@@ -28,4 +28,4 @@ hrp adb install [flags] PACKAGE
* [hrp adb](hrp_adb.md) - simple utils for android device management * [hrp adb](hrp_adb.md) - simple utils for android device management
###### Auto generated by spf13/cobra on 26-May-2025 ###### Auto generated by spf13/cobra on 8-Jun-2025
docs/cmd/hrp_adb_screencap.md
+1 -1
View File
@@ -25,4 +25,4 @@ hrp adb screencap [flags]
* [hrp adb](hrp_adb.md) - simple utils for android device management * [hrp adb](hrp_adb.md) - simple utils for android device management
###### Auto generated by spf13/cobra on 26-May-2025 ###### Auto generated by spf13/cobra on 8-Jun-2025
docs/cmd/hrp_build.md
+1 -1
View File
@@ -36,4 +36,4 @@ hrp build $path ... [flags]
* [hrp](hrp.md) - All-in-One Testing Framework for API, UI and Performance * [hrp](hrp.md) - All-in-One Testing Framework for API, UI and Performance
###### Auto generated by spf13/cobra on 26-May-2025 ###### Auto generated by spf13/cobra on 8-Jun-2025
docs/cmd/hrp_convert.md
+1 -1
View File
@@ -34,4 +34,4 @@ hrp convert $path... [flags]
* [hrp](hrp.md) - All-in-One Testing Framework for API, UI and Performance * [hrp](hrp.md) - All-in-One Testing Framework for API, UI and Performance
###### Auto generated by spf13/cobra on 26-May-2025 ###### Auto generated by spf13/cobra on 8-Jun-2025
docs/cmd/hrp_ios.md
+1 -1
View File
@@ -29,4 +29,4 @@ simple utils for ios device management
* [hrp ios uninstall](hrp_ios_uninstall.md) - uninstall package automatically * [hrp ios uninstall](hrp_ios_uninstall.md) - uninstall package automatically
* [hrp ios xctest](hrp_ios_xctest.md) - run xctest * [hrp ios xctest](hrp_ios_xctest.md) - run xctest
###### Auto generated by spf13/cobra on 26-May-2025 ###### Auto generated by spf13/cobra on 8-Jun-2025
docs/cmd/hrp_ios_apps.md
+1 -1
View File
@@ -26,4 +26,4 @@ hrp ios apps [flags]
* [hrp ios](hrp_ios.md) - simple utils for ios device management * [hrp ios](hrp_ios.md) - simple utils for ios device management
###### Auto generated by spf13/cobra on 26-May-2025 ###### Auto generated by spf13/cobra on 8-Jun-2025
docs/cmd/hrp_ios_devices.md
+1 -1
View File
@@ -24,4 +24,4 @@ hrp ios devices [flags]
* [hrp ios](hrp_ios.md) - simple utils for ios device management * [hrp ios](hrp_ios.md) - simple utils for ios device management
###### Auto generated by spf13/cobra on 26-May-2025 ###### Auto generated by spf13/cobra on 8-Jun-2025
docs/cmd/hrp_ios_install.md
+1 -1
View File
@@ -25,4 +25,4 @@ hrp ios install [flags] PACKAGE
* [hrp ios](hrp_ios.md) - simple utils for ios device management * [hrp ios](hrp_ios.md) - simple utils for ios device management
###### Auto generated by spf13/cobra on 26-May-2025 ###### Auto generated by spf13/cobra on 8-Jun-2025
docs/cmd/hrp_ios_mount.md
+1 -1
View File
@@ -28,4 +28,4 @@ hrp ios mount [flags]
* [hrp ios](hrp_ios.md) - simple utils for ios device management * [hrp ios](hrp_ios.md) - simple utils for ios device management
###### Auto generated by spf13/cobra on 26-May-2025 ###### Auto generated by spf13/cobra on 8-Jun-2025
docs/cmd/hrp_ios_ps.md
+1 -1
View File
@@ -26,4 +26,4 @@ hrp ios ps [flags]
* [hrp ios](hrp_ios.md) - simple utils for ios device management * [hrp ios](hrp_ios.md) - simple utils for ios device management
###### Auto generated by spf13/cobra on 26-May-2025 ###### Auto generated by spf13/cobra on 8-Jun-2025
docs/cmd/hrp_ios_reboot.md
+1 -1
View File
@@ -25,4 +25,4 @@ hrp ios reboot [flags]
* [hrp ios](hrp_ios.md) - simple utils for ios device management * [hrp ios](hrp_ios.md) - simple utils for ios device management
###### Auto generated by spf13/cobra on 26-May-2025 ###### Auto generated by spf13/cobra on 8-Jun-2025
docs/cmd/hrp_ios_tunnel.md
+1 -1
View File
@@ -24,4 +24,4 @@ hrp ios tunnel [flags]
* [hrp ios](hrp_ios.md) - simple utils for ios device management * [hrp ios](hrp_ios.md) - simple utils for ios device management
###### Auto generated by spf13/cobra on 26-May-2025 ###### Auto generated by spf13/cobra on 8-Jun-2025
docs/cmd/hrp_ios_uninstall.md
+1 -1
View File
@@ -26,4 +26,4 @@ hrp ios uninstall [flags] PACKAGE
* [hrp ios](hrp_ios.md) - simple utils for ios device management * [hrp ios](hrp_ios.md) - simple utils for ios device management
###### Auto generated by spf13/cobra on 26-May-2025 ###### Auto generated by spf13/cobra on 8-Jun-2025
docs/cmd/hrp_ios_xctest.md
+1 -1
View File
@@ -28,4 +28,4 @@ hrp ios xctest [flags]
* [hrp ios](hrp_ios.md) - simple utils for ios device management * [hrp ios](hrp_ios.md) - simple utils for ios device management
###### Auto generated by spf13/cobra on 26-May-2025 ###### Auto generated by spf13/cobra on 8-Jun-2025
docs/cmd/hrp_mcp-server.md
+1 -1
View File
@@ -28,4 +28,4 @@ hrp mcp-server [flags]
* [hrp](hrp.md) - All-in-One Testing Framework for API, UI and Performance * [hrp](hrp.md) - All-in-One Testing Framework for API, UI and Performance
###### Auto generated by spf13/cobra on 26-May-2025 ###### Auto generated by spf13/cobra on 8-Jun-2025
docs/cmd/hrp_mcphost.md
+1 -1
View File
@@ -31,4 +31,4 @@ hrp mcphost [flags]
* [hrp](hrp.md) - All-in-One Testing Framework for API, UI and Performance * [hrp](hrp.md) - All-in-One Testing Framework for API, UI and Performance
###### Auto generated by spf13/cobra on 26-May-2025 ###### Auto generated by spf13/cobra on 8-Jun-2025
docs/cmd/hrp_pytest.md
+1 -1
View File
@@ -24,4 +24,4 @@ hrp pytest $path ... [flags]
* [hrp](hrp.md) - All-in-One Testing Framework for API, UI and Performance * [hrp](hrp.md) - All-in-One Testing Framework for API, UI and Performance
###### Auto generated by spf13/cobra on 26-May-2025 ###### Auto generated by spf13/cobra on 8-Jun-2025
docs/cmd/hrp_report.md
+36
View File
@@ -0,0 +1,36 @@
## hrp report
Generate HTML report from test results
### Synopsis
Generate report.html from test results in the specified folder.
The folder should contain summary.json and optionally hrp.log files.
Examples:
$ hrp report results/20250607234602/
$ hrp report /path/to/test/results/
```
hrp report [result_folder] [flags]
```
### Options
```
-h, --help help for report
```
### 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
###### Auto generated by spf13/cobra on 8-Jun-2025
docs/cmd/hrp_run.md
+2 -1
View File
@@ -28,6 +28,7 @@ hrp run $path... [flags]
--http-stat turn on HTTP latency stat (DNSLookup, TCP Connection, etc.) --http-stat turn on HTTP latency stat (DNSLookup, TCP Connection, etc.)
--log-plugin turn on plugin logging --log-plugin turn on plugin logging
--log-requests-off turn off request & response details logging --log-requests-off turn off request & response details logging
--mcp-config string path to the MCP config file
-p, --proxy-url string set proxy url -p, --proxy-url string set proxy url
-s, --save-tests save tests summary -s, --save-tests save tests summary
``` ```
@@ -44,4 +45,4 @@ hrp run $path... [flags]
* [hrp](hrp.md) - All-in-One Testing Framework for API, UI and Performance * [hrp](hrp.md) - All-in-One Testing Framework for API, UI and Performance
###### Auto generated by spf13/cobra on 26-May-2025 ###### Auto generated by spf13/cobra on 8-Jun-2025
docs/cmd/hrp_server.md
+1 -1
View File
@@ -30,4 +30,4 @@ hrp server start [flags]
* [hrp](hrp.md) - All-in-One Testing Framework for API, UI and Performance * [hrp](hrp.md) - All-in-One Testing Framework for API, UI and Performance
###### Auto generated by spf13/cobra on 26-May-2025 ###### Auto generated by spf13/cobra on 8-Jun-2025
docs/cmd/hrp_startproject.md
+1 -1
View File
@@ -29,4 +29,4 @@ hrp startproject $project_name [flags]
* [hrp](hrp.md) - All-in-One Testing Framework for API, UI and Performance * [hrp](hrp.md) - All-in-One Testing Framework for API, UI and Performance
###### Auto generated by spf13/cobra on 26-May-2025 ###### Auto generated by spf13/cobra on 8-Jun-2025
docs/cmd/hrp_wiki.md
+1 -1
View File
@@ -24,4 +24,4 @@ hrp wiki [flags]
* [hrp](hrp.md) - All-in-One Testing Framework for API, UI and Performance * [hrp](hrp.md) - All-in-One Testing Framework for API, UI and Performance
###### Auto generated by spf13/cobra on 26-May-2025 ###### Auto generated by spf13/cobra on 8-Jun-2025
internal/version/VERSION
+1 -1
View File
@@ -1 +1 @@
v5.0.0-beta-2506082348 v5.0.0-beta-2506090006
report.go
+25
View File
@@ -1062,6 +1062,14 @@ const htmlTemplate = `<!DOCTYPE html>
.screenshot-image { .screenshot-image {
text-align: center; text-align: center;
display: flex;
justify-content: center;
align-items: center;
min-height: 300px;
padding: 20px 0;
background: linear-gradient(135deg, #f8f9fa 0%, #e9ecef 100%);
border-radius: 8px;
margin: 10px 0;
} }
.screenshot-image img { .screenshot-image img {
@@ -1070,12 +1078,19 @@ const htmlTemplate = `<!DOCTYPE html>
border-radius: 6px; border-radius: 6px;
cursor: pointer; cursor: pointer;
transition: transform 0.2s; transition: transform 0.2s;
object-fit: contain;
box-shadow: 0 2px 8px rgba(0,0,0,0.1);
} }
.screenshot-image img:hover { .screenshot-image img:hover {
transform: scale(1.02); transform: scale(1.02);
} }
.screenshot-item.small .screenshot-image {
min-height: 250px;
padding: 15px 0;
}
.screenshot-item.small .screenshot-image img { .screenshot-item.small .screenshot-image img {
max-height: 200px; max-height: 200px;
} }
@@ -1444,10 +1459,20 @@ const htmlTemplate = `<!DOCTYPE html>
gap: 10px; gap: 10px;
} }
.screenshot-image {
min-height: 250px;
padding: 15px 0;
}
.screenshot-image img { .screenshot-image img {
max-height: 250px; max-height: 250px;
} }
.screenshot-item.small .screenshot-image {
min-height: 200px;
padding: 10px 0;
}
.screenshot-item.small .screenshot-image img { .screenshot-item.small .screenshot-image img {
max-height: 150px; max-height: 150px;
} }