https://github.com/hupe1980/mwaacli
mwaacli is a command-line interface (CLI) for interacting with Amazon Managed Workflows for Apache Airflow (MWAA). It provides an easy way to manage MWAA environments, execute Airflow CLI commands, and open the MWAA web UI.
https://github.com/hupe1980/mwaacli
airflow cli mwaa
Last synced: 28 days ago
JSON representation
mwaacli is a command-line interface (CLI) for interacting with Amazon Managed Workflows for Apache Airflow (MWAA). It provides an easy way to manage MWAA environments, execute Airflow CLI commands, and open the MWAA web UI.
- Host: GitHub
- URL: https://github.com/hupe1980/mwaacli
- Owner: hupe1980
- License: mit
- Created: 2025-03-08T13:17:55.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-03-12T22:51:21.000Z (7 months ago)
- Last Synced: 2025-03-12T23:24:50.877Z (7 months ago)
- Topics: airflow, cli, mwaa
- Language: Go
- Homepage:
- Size: 18.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mwaacli
[](https://pkg.go.dev/github.com/hupe1980/mwaacli)
[](https://goreportcard.com/report/github.com/hupe1980/mwaacli)
[](https://opensource.org/licenses/MIT)
> **mwaacli** is a command-line interface (CLI) for interacting with Amazon Managed Workflows for Apache Airflow (MWAA).
It simplifies the management of MWAA environments, allows execution of Airflow CLI commands, provides quick access to the MWAA web UI, and supports the AWS MWAA Local Runner for local testing and development.
## 🚀 Features
- **List MWAA environments**: Easily list all your MWAA environments.
- **Get details of a specific MWAA environment**: Retrieve detailed information about a specific MWAA environment.
- **Execute Airflow CLI commands in MWAA**: Run Airflow CLI commands directly within MWAA.
- **Call Airflow Rest API**: Interact with the Airflow Rest API seamlessly.
- **AWS MWAA Local Runner Support**: Set up and control a local MWAA environment for testing and development.
- **Open the MWAA web UI in a browser**: Quickly open the MWAA web UI in your default browser.
- **Manage Airflow SecurityBackends**: Handle Airflow SecurityBackends efficiently.
## 📦 Installation
### Using Homebrew (MacOS)
```sh
brew tap hupe1980/mwaacli
brew install mwaacli
```
### Using deb/rpm/apk Packages
Download the `.deb`, `.rpm`, or `.apk` package from the [releases page](https://github.com/hupe1980/mwaacli/releases) and install it using the appropriate package manager for your system.
### Manual Installation
Download the pre-compiled binaries from the [releases page](https://github.com/hupe1980/mwaacli/releases) and copy them to your desired location.
## 🛠 Usage
The mwaacli application supports various commands. Use the `--help` flag to see available commands and their descriptions:
```txt
./mwaacli --help
mwaacli is a command-line interface for interacting with Amazon Managed Workflows for Apache Airflow (MWAA).
Usage:
mwaacli [command]
Available Commands:
completion Generate the autocompletion script for the specified shell
dags Manage DAGs in MWAA
environments Manage MWAA environments
help Help about any command
local Setup and control the AWS MWAA local runner
logs Fetch logs from CloudWatch for an MWAA environment
open Open the MWAA webapp in a browser
roles Manage Airflow roles
run Execute an Airflow CLI command in MWAA
sb Manage secrets backend
variables Manage variables in MWAA
Flags:
-h, --help help for mwaacli
--profile string AWS profile
--region string AWS region
-v, --version version for mwaacli
Use "mwaacli [command] --help" for more information about a command.
```
## 🔧 Setting Up the AWS MWAA Local Runner
The AWS MWAA Local Runner allows you to test and develop workflows locally. Follow these steps to set up the local runner:
1. **Initialize the Local Runner**:
Use the `mwaacli local init` command to clone and set up the AWS MWAA Local Runner repository:
```sh
mwaacli local init
```
2. **Start the Local Runner**:
Start the local runner environment:
```sh
mwaacli local start --port 8080
```
3. **Access the Airflow Web UI**:
Open your browser and navigate to:
```
http://localhost:8080
```
4. **Follow Logs (Optional)**:
To follow the logs of the local runner, use the `--follow-logs` flag:
```sh
mwaacli local start --port 8080 --follow-logs
```
For more details, refer to the [AWS MWAA Local Runner documentation](https://github.com/aws/aws-mwaa-local-runner).
## 🤝 Contributing
Contributions are welcome! Please open an issue or submit a pull request for any improvements or bug fixes.
## 📝 License
This project is licensed under the MIT License. See the LICENSE file for more details.