This is an automated email from the ASF dual-hosted git repository.
bugraoz pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/airflow.git
The following commit(s) were added to refs/heads/main by this push:
new 084495d24d7 docs: add README.md in `airflow-ctl` (#49464)
084495d24d7 is described below
commit 084495d24d79094ab61268944ac7c7807e6496be
Author: Guan Ming(Wesley) Chiu <105915352+guan404m...@users.noreply.github.com>
AuthorDate: Wed Apr 23 07:30:16 2025 +0800
docs: add README.md in `airflow-ctl` (#49464)
---
airflow-ctl/README.md | 29 +++++++++++++++++++++++++++++
1 file changed, 29 insertions(+)
diff --git a/airflow-ctl/README.md b/airflow-ctl/README.md
index ef14affc68c..6c2908b7431 100644
--- a/airflow-ctl/README.md
+++ b/airflow-ctl/README.md
@@ -16,3 +16,32 @@
specific language governing permissions and limitations
under the License.
-->
+
+# airflowctl
+
+A command-line tool for interacting with Apache Airflow instances through the
Airflow REST API. It offers a convenient interface for performing common
operations remotely without direct access to the Airflow scheduler or webserver.
+
+## Features
+
+- Communicates with Airflow instances through the REST API
+- Supports authentication using Airflow API tokens
+- Executes commands against remote Airflow deployments
+- Provides intuitive command organization with group-based structure
+- Includes detailed help documentation for all commands
+
+## Requirements
+
+- Python 3.9 or later (compatible with Python >= 3.9 and < 3.13)
+- Network access to an Apache Airflow instance with REST API enabled
+
+## Usage
+
+Access the tool from your terminal:
+
+```bash
+airflowctl --help
+```
+
+## Contributing
+
+Want to help improve Apache Airflow? Check out our [contributing
documentation](https://github.com/apache/airflow/blob/main/contributing-docs/README.rst).
