abctl

README

abctl

Airbyte's command line tool for running Airbyte locally.

---

• Getting Started
  • Prerequisites
  • Installation
  • Launch
  • Additional Options
• Contributing

Getting Started

Prerequisites

1. Docker installed
   • Mac instructions
   • Windows instructions
   • Linux instructions

Installation

Do one of the following:

• Install using brew

  brew tap airbytehq/tap
  brew install abctl
  

• Install using go install

  go install github.com/airbytehq/abctl@latest
  

• Download the latest version of abctl from the releases page

Launch

To launch Airbyte locally with the default settings, simply run

abctl local install 

After the local install command completes successfully, your browser should have launched and redirected you to http://localhost. You will need to provide credentials in order to access Airbyte locally, which default to the username airbyte and the password password.

These credentials can be changed either of the following

• passing the --username and --password flags to the local install command

  abctl local install --username foo --password bar
  

• defining the environment variables ABCTL_LOCAL_INSTALL_USERNAME and ABCTL_LOCAL_INSTALL_PASSWORD

  ABCTL_LOCAL_INSTALL_USERNAME=foo
  ABCTL_LOCAL_INSTALL_PASSWORD=bar
  abctl local install
  

Additional Options

For additional options supported by abctl, pass the --help flag

abctl --help

Usage:
  abctl [command]

Available Commands:
  help        Help about any command
  local       Manages local Airbyte installations
  version     Print version information

Flags:
  -h, --help      help for abctl
  -v, --verbose   enable verbose output

abctl local install --help

Usage:
  abctl local install [flags]

Flags:
      --chart-version string   specify the specific Airbyte helm chart version to install (default "latest")
  -h, --help                   help for install
  -p, --password string        basic auth password, can also be specified via ABCTL_LOCAL_INSTALL_PASSWORD (default "password")
      --port int               ingress http port (default 8000)
  -u, --username string        basic auth username, can also be specified via ABCTL_LOCAL_INSTALL_USERNAME (default "airbyte")

Global Flags:
  -v, --verbose   enable verbose output

Contributing

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.