TunnelHub CLI

TunnelHub CLI is a command-line interface tool that helps developers interact with TunnelHub services directly from their terminal. It simplifies managing environments, packages, and automations for creating and deploying integrations in the TunnelHub ecosystem.

Features

• Secure authentication with TunnelHub accounts
• Environment management and listing
• Package creation and listing
• Automation creation, listing, and deployment
• Support for different runtime engines (Lambda and ECS Fargate)
• Intuitive command-line interface with guided prompts

Installation

To use the TunnelHub CLI, you need Node.js installed on your system. Download it from nodejs.org if you don't have it yet.

Install the TunnelHub CLI globally using npm:

npm install -g @tunnelhub/cli

Or using yarn:

yarn global add @tunnelhub/cli

After installation, you can access the CLI using either tunnelhub or the shorthand th command.

Usage

Authentication

Before using TunnelHub CLI, you need to authenticate with your TunnelHub account:

tunnelhub login

This will open a browser window for OAuth authentication. If you prefer password-based authentication:

tunnelhub login --password

To verify your authentication status:

tunnelhub login-check

To log out and remove your credentials:

tunnelhub logout

Managing Environments

List your available environments:

tunnelhub list-environments

Working with Packages

List your existing packages:

tunnelhub list-packages

Create a new package:

tunnelhub create-package

Working with Automations

List your automations:

tunnelhub list-automations

Create a new automation:

tunnelhub create-automation --env [environment-id]

When creating automations, you can choose from four base designs:

• No delta (individual)
• No delta (batch)
• Delta (individual)
• Delta (batch)

Deploy an automation:

tunnelhub deploy-automation --env [environment-id] --automation [automation-id]

Help and Version

Display the help menu:

tunnelhub --help

Check the CLI version:

tunnelhub --version

Common Workflows

Creating and Deploying an Automation

1. Log in to your TunnelHub account:

   tunnelhub login

2. List your environments and note the environment ID where you want to create the automation:

   tunnelhub list-environments

3. Create a new automation:

   tunnelhub create-automation --env [environment-id]

4. Follow the interactive prompts to configure your automation settings, including the automation type, runtime engine, and other parameters.

5. Deploy your automation:

   tunnelhub deploy-automation --env [environment-id] --automation [automation-id]

Support

If you encounter any issues or have questions about using TunnelHub CLI, please visit our GitHub repository or contact support at the email provided in the package information.

License

TunnelHub CLI is licensed under the ISC License.