|
| 1 | +# UseWebhook CLI |
| 2 | + |
| 3 | +[UseWebhook](https://usewebhook.com/) is a free tool to capture webhooks from your browser. |
| 4 | + |
| 5 | +- ⚡️ Test webhooks without a server |
| 6 | +- 🔍 Inspect and diff incoming requests |
| 7 | +- 👨💻 Forward to localhost, or replay from history |
| 8 | +- ✅ Debug webhooks from Stripe, Paddle, Slack, or anywhere else |
| 9 | + |
| 10 | +No sign up required. Just send HTTP requests to your webhook URL. |
| 11 | + |
| 12 | +## Installation |
| 13 | + |
| 14 | +The easiest way to install is using the automated script: |
| 15 | + |
| 16 | +``` |
| 17 | +curl -sSL https://usewebhook.com/install.sh | bash |
| 18 | +``` |
| 19 | + |
| 20 | +It will detect your OS and architecture, download the corresponding executable, and add it to your PATH. |
| 21 | + |
| 22 | +Alternatively, you can download the binary for your operating system from the [releases page](https://github.com/figstra/usewebhook-cli/releases), or [build from source](#build-from-source) if you'd like. |
| 23 | + |
| 24 | +## Usage |
| 25 | + |
| 26 | +Create a new webhook and start listening: |
| 27 | + |
| 28 | +```bash |
| 29 | +$ usewebhook |
| 30 | + |
| 31 | +> Dashboard: https://usewebhook.com/?id=123 |
| 32 | +> Webhook URL: https://usewebhook.com/123 |
| 33 | +``` |
| 34 | + |
| 35 | +Listen for requests to a specific webhook: |
| 36 | + |
| 37 | +```bash |
| 38 | +$ usewebhook <webhook-URL> |
| 39 | +``` |
| 40 | + |
| 41 | +Forward incoming requests to localhost: |
| 42 | + |
| 43 | +```bash |
| 44 | +$ usewebhook <webhook-URL> --forward-to http://localhost:8080/your-endpoint |
| 45 | +``` |
| 46 | + |
| 47 | +Replay a specific request from the webhook's history: |
| 48 | + |
| 49 | +```bash |
| 50 | +$ usewebhook <webhook-URL> --request-id <request-ID> -f http://localhost:8080/your-endpoint |
| 51 | +``` |
| 52 | + |
| 53 | + |
| 54 | +## Build from source |
| 55 | + |
| 56 | +1. Ensure you have Go installed on your system. |
| 57 | +2. Clone the repository: |
| 58 | + ``` |
| 59 | + git clone https://github.com/figstra/usewebhook-cli |
| 60 | + ``` |
| 61 | +3. Navigate to the project directory: |
| 62 | + ``` |
| 63 | + cd usewebhook-cli |
| 64 | + ``` |
| 65 | +4. Build the binary: |
| 66 | + ``` |
| 67 | + go build -o usewebhook |
| 68 | + ``` |
| 69 | +5. Move the binary to your PATH: |
| 70 | + ``` |
| 71 | + sudo mv ./usewebhook /usr/local/bin/ |
| 72 | + ``` |
| 73 | + |
| 74 | + |
| 75 | +## Contributing |
| 76 | + |
| 77 | +Contributions are welcome! In case you want to add a feature, please create a new issue and briefly explain what the feature would consist of. |
| 78 | + |
| 79 | +Simply follow the next steps: |
| 80 | + |
| 81 | +- Fork the project. |
| 82 | +- Create a new branch. |
| 83 | +- Make your changes and write tests when practical. |
| 84 | +- Commit your changes to the new branch. |
| 85 | +- Send a pull request, it will be reviewed shortly. |
| 86 | + |
| 87 | +## Change log |
| 88 | + |
| 89 | +- **1.0.0:** Release v1 |
| 90 | + |
| 91 | +## License |
| 92 | + |
| 93 | +This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details. |
0 commit comments