Skip to content

Commit

Permalink
added exit codes to cli docs
Browse files Browse the repository at this point in the history
  • Loading branch information
johnsmyth committed Oct 18, 2024
1 parent 35696d1 commit db5d05a
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions docs/reference/cli/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,3 +128,20 @@ sidebar_label: Flowpipe CLI

---


## Exit Codes

| Value | Name | Description
|---------|---------------------------------------|----------------------------------------
| **0** | `ExitCodeSuccessful` | Flowpipe ran successfully
| **1** | `ExitCodeExecutionPaused` | Flowpipe ran without errors but paused waiting input
| **2** | `ExitCodeExecutionFailed` | Flowpipe completed with one or more errors
| **3** | `ExitCodeExecutionCancelled` | The Flowpipe command was canceelled by user request
| **61** | `ExitCodeModInitFailed` | Mod init failed
| **62** | `ExitCodeModInstallFailed` | Mod install failed
| **250** | `ExitCodeInitializationFailed` | Initialization failed
| **251** | `ExitCodeBindPortUnavailable` | Network port binding failed
| **252** | `ExitCodeNoModFile` | The command requires a mod, but no mod file was found
| **253** | `ExitCodeFileSystemAccessFailure` | File system access failed
| **254** | `ExitCodeInsufficientOrWrongInputs` | Runtime error - insufficient or incorrect input
| **255** | `ExitCodeUnknownErrorPanic` | Runtime error - an unknown panic occurred

0 comments on commit db5d05a

Please sign in to comment.