Skip to content

faluapp/falu-cli

Repository files navigation

Falu CLI

Release GitHub Workflow Status

The official CLI tool for Falu to help you build, test, and manage your Falu integration right from the terminal.

Available features:

  • Manage your message templates in bulk (or via CI)
  • Tail your API request logs for real-time insights.
  • Resend webhook events effortlessly for simplified testing.
  • Test webhooks securely, eliminating the need for external software.

Usage

Installing the CLI provides access to the falu command.

falu [command]
# Run `-h` for detailed information about the tool
falu -h

# Run `-h` for detailed information about commands
falu [command] -h

Commands

The Falu CLI supports a broad range of commands including:

Check out the wiki for more on using the CLI.

Installation

Falu CLI is available for macOS, Windows and Linux (Ubuntu). You can download each of the binaries in the releases or you can use package managers in the respective platforms.

macOS

Falu CLI is available on macOS via Homebrew:

brew install faluapp/falu-cli/falu

Windows

Falu CLI is available on Windows via Scoop package manager:

scoop bucket add falu https://github.com/faluapp/scoop-falu-cli.git
scoop install falu

Docker

The CLI is also available as a Docker image: ghcr.io/faluapp/falu-cli.

docker run --rm -it ghcr.io/faluapp/falu-cli --version
a.b.c+commit

Issues & Comments

Feel free to contact us if you encounter any issues with the library. Please leave all comments, bugs, requests and issues on the Issues page.

Development

For any requests, bug or comments, please open an issue or submit a pull request.

License

The Library is licensed under the MIT license. Refer to the LICENSE file for more information.