iFlow CLI GitHub Action

A Docker-based GitHub Action for running iFlow CLI commands with pre-installed tools

iFlow Icon

View on GitHub

✨ Key Features

  • Docker-based action with pre-installed Node.js 22, npm, go, cargo, and uv
  • Configurable authentication with iFlow API
  • Support for MCP servers (Model Context Protocol)
  • Agent Client Protocol with Rust ACP Websocket client
  • Support for custom models and API endpoints
  • Flexible command execution with timeout control
  • GitHub Actions Summary integration for rich execution reports
  • Built with Rust for fast, reliable execution

📦 Installation Guide

Step 1: Add to your workflow


name: iFlow CLI Example
on: [push]

jobs:
  iflow-cli:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Run iFlow CLI
        uses: iflow-ai/iflow-cli-action@v2.0.0
        with:
          api_key: ${{ secrets.IFLOW_API_KEY }}
          prompt: "Analyze this codebase"
                

Step 2: Set up API key

Add your iFlow API key to repository secrets as IFLOW_API_KEY

📝 Usage Example

Issue Triage with iFlow CLI


- name: Run iFlow CLI Issue Triage
  uses: iflow-ai/iflow-cli-action@v2.0.0
  with:
    api_key: ${{ secrets.IFLOW_API_KEY }}
    timeout: "3600"
    debug: "true"
    prompt: |
      ## Role
      
      You are an issue triage assistant. Analyze the current GitHub issue
      and apply the most appropriate existing labels...
                

🚀 Advanced Features

Pre-Execution Commands


precmd: |
  npm install
  npm run build
  git fetch origin main
                

Custom Settings JSON


settings_json: |
  {
    "theme": "Dark",
    "selectedAuthType": "iflow",
    "apiKey": "${{ secrets.IFLOW_API_KEY }}",
    "baseUrl": "https://custom-api.example.com/v1",
    "modelName": "custom-model"
  }
                

⚙️ Inputs & Outputs

Required Inputs

Input Description
prompt The prompt to execute with iFlow CLI
api_key iFlow API key for authentication

Available Outputs

Output Description
result Output from iFlow CLI execution
exit_code Exit code from iFlow CLI execution

🙏 Thank You

Thank you for using iFlow CLI GitHub Action!

Star on GitHub Contribute

Built with ❤️ by the iFlow team