Skip to content

Commit f9321bb

Browse files
committed
docs: fold exit codes into the API Reference index page
1 parent 6dc9db9 commit f9321bb

5 files changed

Lines changed: 16 additions & 20 deletions

File tree

docs.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -390,8 +390,7 @@
390390
"qawolf/libraries/cli/api-reference/index",
391391
"qawolf/libraries/cli/api-reference/commands",
392392
"qawolf/libraries/cli/api-reference/configuration",
393-
"qawolf/libraries/cli/api-reference/environment-variables",
394-
"qawolf/libraries/cli/api-reference/exit-codes"
393+
"qawolf/libraries/cli/api-reference/environment-variables"
395394
]
396395
},
397396
{

qawolf/libraries/cli/api-reference/commands.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Options:
6262
- `--headed` — show the browser window instead of running headless. Default: `false`.
6363
- `--env <env>` — environment ID. When set, missing flows are pulled before the run.
6464

65-
Exit codes: `0` when all flows pass, `1` when one or more flows fail, `2` for invalid arguments or an unrecognized flow target. See [Exit codes](/qawolf/libraries/cli/api-reference/exit-codes).
65+
Exit codes: `0` when all flows pass, `1` when one or more flows fail, `2` for invalid arguments or an unrecognized flow target. See [Exit codes](/qawolf/libraries/cli/api-reference/index#exit-codes).
6666

6767
### `flows list [pattern]`
6868

qawolf/libraries/cli/api-reference/exit-codes.mdx

Lines changed: 0 additions & 16 deletions
This file was deleted.

qawolf/libraries/cli/api-reference/index.mdx

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,16 @@ The following flags apply to every command:
3131
- `--agent` — formats output for agent consumption.
3232

3333
When a recognized CI environment is detected (`CI`, `GITHUB_ACTIONS`, `GITLAB_CI`, `CIRCLECI`, `JENKINS_URL`, `BUILDKITE`), output defaults to JSON. When a recognized agent environment is detected (`CLAUDE_CODE`, `CURSOR_SESSION_ID`), output defaults to agent mode.
34+
35+
## Exit Codes
36+
37+
Every qawolf CLI command exits with one of the codes below.
38+
39+
| Code | Name | Meaning |
40+
| --- | --- | --- |
41+
| `0` | `success` | The command completed successfully. |
42+
| `1` | `testFailure` | One or more flows failed. |
43+
| `2` | `invalidArgs` | A Commander parse error, an unknown subcommand, or a bad flag value. |
44+
| `3` | `auth` | `QAWOLF_API_KEY` is missing or invalid. |
45+
| `4` | `network` | The QA Wolf API was unreachable, a download from storage failed, or a registry was unreachable. |
46+
| `5` | `config` | `qawolf.config.ts` is invalid, or a file collision occurred during `qawolf init`. |

qawolf/local-execution/run-flows-locally.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ The CLI discovers flows matching `**/*.flow.{ts,js}` in the current directory an
102102

103103
## Exit codes
104104

105-
`qawolf flows run` exits with `0` when every flow passes and `1` when one or more fail. See [Exit codes](/qawolf/libraries/cli/api-reference/exit-codes) for the full list.
105+
`qawolf flows run` exits with `0` when every flow passes and `1` when one or more fail. See [Exit codes](/qawolf/libraries/cli/api-reference/index#exit-codes) for the full list.
106106

107107
## Current limitations
108108

0 commit comments

Comments
 (0)