-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
9e88758
commit b6157a5
Showing
1 changed file
with
74 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,77 @@ | ||
# abctl | ||
<p align="center"> | ||
<img alt="abctl logo" src="https://avatars.githubusercontent.com/u/59758427?size=200" height="140" /> | ||
<h3 align="center">abctl</h3> | ||
<p align="center">Airbyte command line tool for running Airbyte locally.</p> | ||
</p> | ||
|
||
--- | ||
|
||
## Getting Started | ||
|
||
## FAQs | ||
### Prerequisites | ||
1. `Docker Desktop` installed (see [instructions](https://docs.docker.com/desktop/install/mac-install/)) | ||
2. `Kubernetes` enabled (see [instructions](https://docs.docker.com/desktop/kubernetes/)) | ||
|
||
### Installation | ||
Do one of the following: | ||
- Download the latest version of `abctl` from the [releases page](https://github.com/airbytehq/abctl/releases) | ||
- Install `abctl` using `go install` | ||
```shell | ||
go install github.com/airbytehq/abctl@latest | ||
``` | ||
|
||
### Launch | ||
To launch Airbyte locally with the default settings, simply run | ||
```shell | ||
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 | ||
```shell | ||
abctl local install --username foo --password bar | ||
``` | ||
- defining the environment variables `ABCTL_LOCAL_INSTALL_USERNAME` and `ABCTL_LOCAL_INSTALL_PASSWORD` | ||
```shell | ||
ABCTL_LOCAL_INSTALL_USERNAME=foo | ||
ABCTL_LOCAL_INSTALL_PASSWORD=bar | ||
abc local install | ||
``` | ||
|
||
### Additional Options | ||
For additional options supported by `abctl`, pass the `--help` flag | ||
```shell | ||
abctl --help | ||
|
||
Usage: | ||
abctl [command] | ||
|
||
Available Commands: | ||
help Help about any command | ||
local Manages local Airbyte installations | ||
version Print the version number | ||
|
||
Flags: | ||
--dnt opt out of telemetry data collection | ||
-h, --help help for abctl | ||
``` | ||
```shell | ||
abctl local install --help | ||
|
||
Usage: | ||
|
||
abctl local install [flags] | ||
|
||
Flags: | ||
-h, --help help for install | ||
-p, --password string basic auth password, can also be specified via ABCTL_LOCAL_INSTALL_PASSWORD (default "password") | ||
-u, --username string basic auth username, can also be specified via ABCTL_LOCAL_INSTALL_USERNAME (default "airbyte") | ||
|
||
Global Flags: | ||
--dnt opt out of telemetry data collection | ||
|
||
``` |