Skip to content

CLI Commands ​

The request-mock CLI is built on cobra. Every subcommand defaults to a structured JSON envelope; pass --raw for bare output. Errors go to stderr as JSON {"ok":false,"error":"..."} with a non-zero exit code.

Command tree ​

mermaid
flowchart TB
    Root["request-mock"] --> Gen["generate"]
    Root --> Tpl["template"]
    Root --> Bat["batch"]
    Root --> Spl["split"]
    Root --> Exp["export"]
    Root --> Ded["dedup"]
    Root --> Add["add-headers"]
    Root --> Clo["clone"]
    Root --> Fmt["formats"]
    Root --> Trn["transforms"]
    Root --> Ver["version"]

    Gen --> GenF["-X -u -H -d -F -Q\n--status --resp-body --server-ip\n-f -o --raw -n --seed --transform"]
    Tpl --> TplF["--list / --name / --url / -f / -o / --raw"]
    Bat --> BatF["--config -n --seed -f -o --raw"]
    Spl --> SplF["--input --by --size --interval -o --raw"]
    Exp --> ExpF["--input -f -o --raw"]
    Ded --> DedF["--input -o --raw"]
    Add --> AddF["--input -H --target -o --raw"]
    Clo --> CloF["--input -o --raw"]

    style Root fill:#fce4ec
    style Gen fill:#e3f2fd

Summary table ​

CommandPurposeReads HAR?Writes HAR?
generateBuild request(s) from params, derive batchnoyes (default)
templateUse a built-in scenario templatenoyes
batchConfig-driven bulk generationnoyes
splitSplit a HAR by dimensionyesyes (parts)
exportConvert a HAR to another formatyesno (stdout/file)
dedupRemove duplicate entriesyesyes
add-headersBatch add request/response headersyesyes
cloneDeep-copy a HARyesyes
formatsList supported export formatsnono (list)
transformsList built-in transformsnono (list)
versionPrint versionnono

Output envelope ​

mermaid
flowchart LR
    In["CLI args"] --> Run["RunE"]
    Run -->|ok| Env["stdout: {ok,count,seed,format,data}"]
    Run -->|error| Err["stderr: {ok:false,error} + exit≠0"]
    Run -->|--raw| Raw["stdout: bare payload"]
    style Env fill:#e8f5e9
    style Err fill:#ffebee
    style Raw fill:#fff3e0

Exit codes ​

  • 0 — success
  • 1 — error (see stderr JSON)

Detailed pages ​

Released under the MIT License.