# Failpath

## Docs

- [Failpath CLI Commands Reference: init, publish, sync](https://docs.failpath.dev/cli/commands.md): Complete reference for all Failpath CLI commands: init, publish, and sync. Covers every flag, argument, and usage example for each command.
- [Failpath CLI Configuration and Environment Variables](https://docs.failpath.dev/cli/configuration.md): Configure the Failpath CLI with environment variables. Set your project key and optional endpoint overrides for local development.
- [Failpath CLI Overview: Manage Flows from Your Repo](https://docs.failpath.dev/cli/overview.md): The Failpath CLI connects your local repository to the Failpath dashboard, letting you initialize projects, sync flow definitions, and publish changes.
- [Step Events: running, success, and error in Failpath](https://docs.failpath.dev/concepts/events.md): Failpath sends running, success, and error events for every step. Understand the event lifecycle and how they appear on your dashboard.
- [Flows: Structure and Manage Backend Processes in Failpath](https://docs.failpath.dev/concepts/flows.md): Flows are the named sequences of steps you define in Failpath. Learn how to structure, publish, and manage flows for your backend processes.
- [Runs and Steps: Instrumenting Flow Executions in Failpath](https://docs.failpath.dev/concepts/runs-and-steps.md): A run is one execution of a flow. Steps are the individual units of work within that run. Learn how they relate and how to instrument them correctly.
- [Configuring Failpath Across Deployment Environments](https://docs.failpath.dev/guides/environments.md): Set up Failpath correctly for local development, production deployments, and test environments, including platform-specific environment variable guides.
- [Handling App Errors and Telemetry Failures in Failpath](https://docs.failpath.dev/guides/error-handling.md): Understand how Failpath captures and rethrows step errors, and how to handle telemetry send failures without disrupting your application.
- [Instrument a Backend Flow with Failpath End to End](https://docs.failpath.dev/guides/instrument-a-flow.md): Walk through adding Failpath step instrumentation to a real backend function, from initializing the CLI to viewing events on your dashboard.
- [Attaching Metadata to Runs, Steps, and Clients in Failpath](https://docs.failpath.dev/guides/metadata.md): Add structured context to your Failpath runs and steps using metadata. Learn how to attach, merge, and use metadata safely across your flows.
- [How Failpath Monitors Your Backend Flows and Steps](https://docs.failpath.dev/introduction.md): Failpath is a flow monitoring tool that tracks every step in your backend workflows, giving you real-time visibility into successes, failures, and skips.
- [Failpath Quickstart: Instrument and Publish Your First Flow](https://docs.failpath.dev/quickstart.md): Initialize Failpath in your repo, instrument a backend function with the TypeScript SDK, and publish your first monitored flow to the dashboard.
- [createFailpathClient: Initializing the Failpath SDK Client](https://docs.failpath.dev/sdk/client.md): Create a Failpath client with createFailpathClient(). Configure your project key, metadata defaults, error handling, and custom fetch options.
- [Failpath SDK: Complete Configuration Options Reference](https://docs.failpath.dev/sdk/options.md): Full reference for all Failpath SDK configuration options, including project key, metadata, error handling, and custom fetch support.
- [Failpath SDK: Instrument Your Backend in TypeScript](https://docs.failpath.dev/sdk/overview.md): The @failpath/sdk package lets you wrap backend functions with step instrumentation, automatically recording success and error events for your flows.
- [Recording Runs and Steps with the Failpath TypeScript SDK](https://docs.failpath.dev/sdk/runs-and-steps.md): Use run() to start a flow execution and step() to instrument individual operations. Learn how to correlate steps, skip them, and record manually.