Getting Started with aflare

August 15, 2026 · View on GitHub

Welcome to aflare! This guide will get you up and running in under 5 minutes.

Step 1: Installation

Linux/macOS

Download the install script from the repository and run it locally:

curl -sL https://raw.githubusercontent.com/alib8b8/aflare/main/install.sh -o install.sh
bash install.sh

国内网络加速（推荐国内用户使用）：

curl -sL https://ghproxy.com/https://raw.githubusercontent.com/alib8b8/aflare/main/install.sh -o install.sh
bash install.sh

Windows

Download the latest binary from the Releases page, then:

Invoke-WebRequest -Uri "https://github.com/alib8b8/aflare/releases/latest/download/aflare-windows-amd64.exe" -OutFile aflare.exe
.\aflare.exe --help

国内网络加速（PowerShell）：

Invoke-WebRequest -Uri "https://ghproxy.com/https://github.com/alib8b8/aflare/releases/latest/download/aflare-windows-amd64.exe" -OutFile aflare.exe
.\aflare.exe --help

Build from Source

git clone https://github.com/alib8b8/aflare.git
cd aflare
go install ./cmd/aflare

国内网络加速（使用 ghproxy 代理克隆）：

git clone https://ghproxy.com/https://github.com/alib8b8/aflare.git
cd aflare
go install ./cmd/aflare

Verify installation:

aflare --help

You should see the aflare help output.

Step 2: Create Your First Workflow

Let's start with a simple workflow: fetch content from a URL and save it to a file.

aflare create "fetch example.com and save to example.html"

This will generate a file called example-workflow.yaml with something like:

name: Fetch and Save Example
steps:
  - node: fetch_url
    params:
      url: https://example.com
  - node: file_write
    params:
      path: example.html

Step 3: Run Your Workflow

aflare run example-workflow.yaml

You'll see the beautiful TUI showing progress:

╔══════════════════════════════════════════════════════════════╗
║ 🚀 aflare - Fetch and Save Example                          ║
╠══════════════════════════════════════════════════════════════╣
║                                                              ║
║ 📝 Fetching URL...                                           ║
║    → fetch_url (https://example.com)                         ║
║                                                              ║
║ ✅ workflow completed in 0.8s                                ║
╚══════════════════════════════════════════════════════════════╝

Check the output file:

cat example.html

Step 4: Explore More Workflows

Check out the examples directory for 10 practical workflows you can use:

  • Daily GitHub summary
  • Research assistant
  • Documentation generator
  • Log monitor
  • Release notes creator
  • Data collector
  • File organizer
  • Content workflow
  • DevOps automation
  • Team reporting

Try them out and modify them to fit your needs!

Step 5: Learn More

Need Help?