Skip to content

Install fault

fault strives to get out of your way and it starts with a smooth installation.

Download fault

fault is provided as a binary targetting the three major platforms: Linux, macOS and Windows.

You may try the installation script:

curl -sSL https://fault-project.com/get | bash

Alternatively, explore our other installation options.

Check fault is ready to roll

Let's verify it all went well by running the following command:

fault --help

This should output the following:

A proxy to test network resilience by injecting various faults.

Usage: fault [OPTIONS] <COMMAND>

Commands:
  run       Resilience Proxy
  inject    Resilience Fault Injection
  scenario  Resilience Automation
  agent     Resilience Agentic Buddy
  demo      Run a simple demo server for learning purpose
  help      Print this message or the help of the given subcommand(s)

Options:
  -h, --help     Print help
  -V, --version  Print version

Logging Options:
      --log-file <LOG_FILE>    Path to the log file. Disabled by default [env: FAULT_LOG_FILE=]
      --log-stdout             Stdout logging enabled [env: FAULT_WITH_STDOUT_LOGGING=]
      --log-level <LOG_LEVEL>  Log level [env: FAULT_LOG_LEVEL=] [default: info]

Observability Options:
      --with-otel  Enable Open Telemetry tracing and metrics. [env: FAULT_WITH_OTEL=]

Troubleshooting

If you receive a message such as ̀fault: No such file or directory, it likely means you have not put the directory containing the fault binary in your PATH, or you may need to restart your session for the changes to take effect.

Next Steps

You’ve successfully downloaded and installed fault. What’s next?

  • Explore our Getting Started Tutorial to learn how to first use fault.
  • Dive into How-To Guides to integrate fault deeper into your workflow, from automated testing to continuous integration.