hookdeck-cli 0.2.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,293 @@
+# Hookdeck CLI
+
+[slack-badge]: https://img.shields.io/badge/Slack-Hookdeck%20Developers-blue?logo=slack
+
+[![slack-badge]](https://join.slack.com/t/hookdeckdevelopers/shared_invite/zt-yw7hlyzp-EQuO3QvdiBlH9Tz2KZg5MQ)
+
+Using the Hookdeck CLI, you can forward your events (e.g. webhooks) to your local web server with unlimited **free** and **permanent** event URLs. Your event history is preserved between sessions and can be viewed, replayed, or used for testing by you and your teammates.
+
+Hookdeck CLI is compatible with most of Hookdeck's features, such as filtering and fan-out delivery. You can use Hookdeck CLI to develop or test your event (e.g. webhook) integration code locally.
+
+Although it uses a different approach and philosophy, it's a replacement for ngrok and alternative HTTP tunnel solutions.
+
+Hookdeck for development is completely free, and we monetize the platform with our production offering.
+
+For a complete reference, see the [CLI reference](https://hookdeck.com/docs/cli?ref=github-hookdeck-cli).
+
+https://github.com/hookdeck/hookdeck-cli/assets/328367/a49dcf59-49ee-4838-9643-b6f90d2ab33e
+
+## Installation
+
+Hookdeck CLI is available for macOS, Windows, and Linux for distros like Ubuntu, Debian, RedHat, and CentOS.
+
+### NPM
+
+Hookdeck CLI is distributed as an NPM package:
+
+```sh
+npm install hookdeck-cli -g
+```
+
+### macOS
+
+Hookdeck CLI is available on macOS via [Homebrew](https://brew.sh/):
+
+```sh
+brew install hookdeck/hookdeck/hookdeck
+```
+
+### Windows
+
+Hookdeck CLI is available on Windows via the [Scoop](https://scoop.sh/) package manager:
+
+```sh
+scoop bucket add hookdeck https://github.com/hookdeck/scoop-hookdeck-cli.git
+scoop install hookdeck
+```
+
+### Linux Or without package managers
+
+To install the Hookdeck CLI on Linux without a package manager:
+
+1. Download the latest linux tar.gz file from https://github.com/hookdeck/hookdeck-cli/releases/latest
+2. Unzip the file: tar -xvf hookdeck_X.X.X_linux_amd64.tar.gz
+3. Run the executable: ./hookdeck
+
+### Docker
+
+The CLI is also available as a Docker image: [`hookdeck/hookdeck-cli`](https://hub.docker.com/r/hookdeck/hookdeck-cli).
+
+```sh
+docker run --rm -it hookdeck/hookdeck-cli version
+hookdeck version x.y.z (beta)
+```
+
+If you want to login to your Hookdeck account with the CLI and persist
+credentials, you can bind mount the `~/.config/hookdeck` directory:
+
+```sh
+docker run --rm -it -v $HOME/.config/hookdeck:/root/.config/hookdeck hookdeck/hookdeck-cli login
+```
+
+Then you can listen on any of your sources. Don't forget to use
+`host.docker.internal` to reach a port on your host machine, otherwise
+that port will not be accessible from `localhost` inside the container.
+
+```sh
+docker run --rm -it -v $HOME/.config/hookdeck:/root/.config/hookdeck hookdeck/hookdeck-cli listen http://host.docker.internal:1234
+```
+
+## Usage
+
+Installing the CLI provides access to the `hookdeck` command.
+
+```sh-session
+hookdeck [command]
+
+# Run `--help` for detailed information about CLI commands
+hookdeck [command] help
+```
+
+## Commands
+
+### Login
+
+Login with your Hookdeck account.
+
+```sh-session
+hookdeck login
+```
+
+> Login is optional, if you do not login a temporary guest account will be created for you when you run other commands.
+
+### Listen
+
+Start a session to forward your events to an HTTP server.
+
+```sh-session
+hookdeck listen <port-or-URL> <source-alias?> <connection-query?>
+```
+
+Hookdeck works by routing events received for a given `source` (i.e., Shopify, Github, etc.) to its defined `destination` by connecting them with a `connection` to a `destination`. The CLI allows you to receive events for any given connection and forward them to your localhost at the specified port or any valid URL.
+
+Each `source` is assigned a Event URL, which you can use to receive events. When starting with a fresh account, the CLI will prompt you to create your first source. Each CLI process can listen to one source at a time.
+
+Contrary to ngrok, **Hookdeck does not allow to append a path to your event URL**. Instead, the routing is done within Hookdeck configuration. This means you will also be prompted to specify your `destination` path, and you can have as many as you want per `source`.
+
+> The `port-or-URL` param is mandatory, events will be forwarded to http://localhost:$PORT/$DESTINATION_PATH when inputing a valid port or your provided URL.
+
+#### Listen to all your connections for a given source
+
+The second param, `source-alias` is used to select a specific source to listen on. By default, the CLI will start listening on all eligible connections for that source.
+
+```sh-session
+$ hookdeck listen 3000 shopify
+
+👉  Inspect and replay events: https://dashboard.hookdeck.com/cli/events
+
+Shopify Source
+🔌 Event URL: https://events.hookdeck.com/e/src_DAjaFWyyZXsFdZrTOKpuHnOH
+
+Connections
+Inventory Service forwarding to /webhooks/shopify/inventory
+Orders Service forwarding to /webhooks/shopify/orders
+
+
+⣾ Getting ready...
+
+```
+
+#### Listen to a subset of connections
+
+The 3rd param, `connection-query` can be used to filter the list of connections the CLI will listen to. The connection query can either be the `connection` `alias` or the `path`
+
+```sh-session
+$ hookdeck listen 3000 shopify orders
+
+👉  Inspect and replay events: https://dashboard.hookdeck.com/cli/events
+
+Shopify Source
+🔌 Event URL: https://events.hookdeck.com/e/src_DAjaFWyyZXsFdZrTOKpuHnOH
+
+Connections
+Inventory Service forwarding to /webhooks/shopify/inventory
+
+
+⣾ Getting ready...
+
+```
+
+#### Viewing and interacting with your events
+
+Event logs for your CLI can be found at [https://dashboard.hookdeck.com/cli/events](https://dashboard.hookdeck.com/cli/events?ref=github-hookdeck-cli). Events can be replayed or saved at any time.
+
+### Logout
+
+Logout of your Hookdeck account and clear your stored credentials.
+
+```sh-session
+hookdeck logout
+```
+
+### Skip SSL validation
+
+If you are developing on an SSL destination, and are using a self-signed certificate, you can skip the SSL validation by using the flag `--insecure`.
+You have to specify the full URL with the protocol when using this flag.
+
+**This is dangerous, and should only be used in development scenarios, and for desitnations that you trust.**
+
+```sh-session
+hookdeck --insecure listen https://<url-or-url:port>/
+```
+
+### Version
+
+Print your CLI version and whether or not a new version is available.
+
+```sh-session
+hookdeck version
+```
+
+### Completion
+
+Configure auto-completion for Hookdeck CLI. It is run on install when using Homebrew or Scoop. You can optionally run this command when using the binaries directly or without a package manager.
+
+```sh-session
+hookdeck completion
+```
+
+### Running in CI
+
+If you want to use Hookdeck in CI for tests or any other purposes, you can use your HOOKDECK_API_KEY to authenticate and start forwarding events.
+
+```sh-session
+$ hookdeck ci --api-key $HOOKDECK_API_KEY
+Done! The Hookdeck CLI is configured in project MyProject
+
+$ hookdeck listen 3000 shopify orders
+
+👉  Inspect and replay events: https://dashboard.hookdeck.com/cli/events
+
+Shopify Source
+🔌 Event URL: https://events.hookdeck.com/e/src_DAjaFWyyZXsFdZrTOKpuHnOH
+
+Connections
+Inventory Service forwarding to /webhooks/shopify/inventory
+
+
+⣾ Getting ready...
+
+```
+
+### Manage active project
+
+If you are a part of multiple project, you can switch between them using our project management commands.
+
+```sh-session
+$ hookdeck project list
+My Project (current)
+Another Project
+Yet Another One
+
+$ hookdeck project use
+Use the arrow keys to navigate: ↓ ↑ → ←
+? Select Project:
+    My Project
+    Another Project
+  ▸ Yet Another One
+
+Selecting project Yet Another One
+
+$ hookdeck whoami
+Using profile default
+Logged in as Me in project Yet Another One
+```
+
+You can also pin an active project in the current working directory with the `--local` flag.
+
+```sh-session
+$ hookdeck project use --local
+Use the arrow keys to navigate: ↓ ↑ → ←
+? Select Project:
+    My Project
+    Another Project
+  ▸ Yet Another One
+
+Selecting project Yet Another One
+```
+
+This will create a local config file in your current directory at `myproject/.hookdeck/config.toml`. Depending on your team's Hookdeck usage and project setup, you may or may not want to commit this configuration file to version control.
+
+## Developing
+
+Build from source by running:
+
+```sh
+go build
+```
+
+### Testing against a local API
+
+When testing against a non-production Hookdeck API, you can use the
+`--api-base` and `--ws-base` flags, e.g.:
+
+```sh
+./hookdeck-cli --api-base http://localhost:9000 --ws-base ws://localhost:3003 listen 1234
+```
+
+Also if running in Docker, the equivalent command would be:
+
+```sh
+docker run --rm -it \
+    -v $HOME/.config/hookdeck:/root/.config/hookdeck hookdeck/hookdeck-cli \
+    --api-base http://host.docker.internal:9000 \
+    --ws-base ws://host.docker.internal:3003 \
+    listen \
+    http://host.docker.internal:1234
+```
+
+## License
+
+Copyright (c) Hookdeck. All rights reserved.
+
+Licensed under the [Apache License 2.0 license](LICENSE).

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "hookdeck-cli",
+  "version": "0.2.0",
+  "description": "Hookdeck CLI",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/hookdeck/hookdeck-cli.git"
+  },
+  "keywords": [
+    "hookdeck",
+    "webhooks"
+  ],
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/hookdeck/hookdeck-cli/issues"
+  },
+  "homepage": "https://github.com/hookdeck/hookdeck-cli#readme",
+  "bin": {
+    "hookdeck": "./bin/hookdeck"
+  },
+  "files": [],
+  "scripts": {
+    "postinstall": "go-npm install",
+    "preuninstall": "go-npm uninstall"
+  },
+  "goBinary": {
+    "name": "hookdeck",
+    "path": "./bin",
+    "url": "https://github.com/hookdeck/hookdeck-cli/releases/download/v{{version}}/hookdeck_{{version}}_{{platform}}_{{arch}}.tar.gz"
+  },
+  "dependencies": {
+    "go-npm-next": "^1.0.6"
+  }
+}