• Quickstart
• Overview
• Commands
• Contributing

1. Install Docker

   • Linux
   • Mac
   • Windows

2. Install abctl

   • Via brew

     brew tap airbytehq/tap
     brew install abctl
     

   • Via go install

     go install github.com/airbytehq/abctl@latest
     

   • Via Github

3. Install Airbyte

   # install Airbyte 
   abctl local install
   # fetch the login credentials
   abctl local credentials
   

4. Login to Airbyte

   If abctl local install completed successfully, it should open a browser to http://localhost:8000 (or to the --host and --port overrides if specified). If this is the first time Airbyte has been installed you will be asked to provide an email and organization name. To retrieve your password to login, run abctl local credentials.

As mentioned in the quickstart, the only prerequisite abctl has is that Docker must be installed, running, and accessible. However, the Airbyte platform requires a Kubernetes cluster, which abctl creates by utilizing kind (kind runs a Kubernetes cluster within a Docker container). With kind's Kubernetes cluster, abctl uses helm to install (or update to) the latest (by default) Airbyte helm chart and the latest NGINX Ingress Controller helm chart.

All commands and sub-commands support the following optional global flags:

All commands support the following environment variables:

The following commands are supported:

• local
• version

abctl local --help

The local sub-commands are focused on managing the local Airbyte installation. The following sub-commands are available:

• credentials
• deployments
• install
• status
• uninstall

abctl local credentials

Displays the credentials required to login to the local Airbyte installation.

Returns ths email, password, client-id, and client-secret credentials. The email and password are required to login to Airbyte. The client-id and client-secret are necessary to create an Access Token for interacting with the Airbyte API.

For example:

$ abctl local credentials
{
  "password": "[RANDOM PASSWORD]",
  "client-id": "[RANDOM CLIENT-ID]",
  "client-secret": "[RANDOM CLIENT-SECRET]"
}

credentials supports the following optional flags

abctl local deployments

Display kubernetes deployment information and allows for restarting a kubernetes deployment.

deployments supports the following optional flags

abctl local install

Installs a local Airbyte instance or updates an existing installation which was initially installed by abctl.

install supports the following optional flags:

The --low-resource-mode flag optimizes Airbyte for environments with limited CPU and memory resources. When enabled, this mode makes the following changes:

Resource Requests:

• Sets all job resource requests (CPU and memory) to 0, allowing Kubernetes to schedule jobs without minimum resource guarantees
• Applies to all job types: check, discover, spec, and sidecar containers

Feature Adjustments:

• Disables the Connector Builder Server to reduce overall resource consumption

This mode is ideal for:

• Development and testing environments with limited resources
• Machines with constrained CPU or memory
• Situations where multiple services need to share limited system resources

Example usage:

abctl local install --low-resource-mode

abctl local status

If an Airbyte installation exists, returns information regarding that installation.

For example:

$ abctl local status
Existing cluster 'airbyte-abctl' found
Found helm chart 'airbyte-abctl'
  Status: deployed
  Chart Version: 0.422.2
  App Version: 0.63.15
Found helm chart 'ingress-nginx'
  Status: deployed
  Chart Version: 4.11.1
  App Version: 1.11.1
Airbyte should be accessible via http://localhost:8000

abctl local uninstall

Uninstalls a local Airbyte instance.

uninstall supports the following optional flags:

abctl images

Manage images used by Airbyte and abctl.

The following sub-commands are available:

• manifest

abctl images manifest

Display a manifest of images used by Airbyte and abctl.

abctl version

Displays version information about the abctl tool.

For example:

$ abctl version
version: v0.19.0

If you have found a problem with abctl, please open a Github Issue and use the 🐛 [abctl] Report an issue with the abctl tool template.

Install go

• Via brew

  brew install go
  

• Via go.dev

This repository utilises a Makefile, wrapping the traditional go commands used for formatting, vetting, building, and testing go code.

The following make commands are supported: