GH-WORKFLOW-RUN(1)             GitHub CLI manual            GH-WORKFLOW-RUN(1)



نام (NAME)
       gh-workflow-run - اجرای یک گردش‌کار با ایجاد رویداد workflow_dispatch



خلاصه دستور (SYNOPSIS)
       gh workflow run [<workflow-id> | <workflow-name>] [flags]



توضیحات (DESCRIPTION)
       ایجاد یک رویداد workflow_dispatch برای یک گردش‌کار مشخص.


       این دستور اقدام به راه‌اندازی GitHub Actions برای اجرای یک فایل گردش‌کار
       مشخص می‌کند. فایل گردش‌کار داده‌شده باید برای اجرا به این روش، از یک محرک
       on.workflow_dispatch پشتیبانی کند.


       اگر فایل گردش‌کار از ورودی‌ها پشتیبانی کند، می‌توان آن‌ها را به چند روش
       تعیین کرد:

       • به‌صورت تعاملی

       • از طریق فلگ‌های -f/--raw-field یا -F/--field

       • به‌صورت JSON، از طریق ورودی استاندارد


       در صورت دردسترس بودن، نشانی اینترنتی (URL) اجرای گردش‌کارِ ایجادشده
       بازگردانده خواهد شد.



گزینه‌ها (OPTIONS)
       -F, --field <key=value>
              افزودن یک پارامتر رشته‌ای در قالب key=value، با رعایت نحو @ (به
              "gh help api" مراجعه کنید).


       --json خواندن ورودی‌های گردش‌کار به‌صورت JSON از طریق STDIN


       -f, --raw-field <key=value>
              افزودن یک پارامتر رشته‌ای در قالب key=value


       -r, --ref <string>
              نام شاخه یا برچسبی (tag) که شامل نسخه‌ای از فایل گردش‌کار است که
              می‌خواهید اجرا کنید



گزینه‌های به ارث رسیده از دستورات والد (OPTIONS INHERITED FROM PARENT COMMANDS)
       -R, --repo <[HOST/]OWNER/REPO>
              انتخاب یک مخزن دیگر با استفاده از قالب [HOST/]OWNER/REPO



کدهای خروج (EXIT CODES)
       0: اجرای موفقیت‌آمیز


       1: خطا


       2: دستور لغو شد


       4: نیاز به احراز هویت است


       نکته: دستورات خاص ممکن است کدهای خروج دیگری نیز داشته باشند. برای
       اطلاعات بیشتر به راهنمای دستور مربوطه مراجعه کنید.



مثال‌ها (EXAMPLES)
       # درخواست gh از شما برای اینکه کدام گردش‌کار را می‌خواهید اجرا کنید و دریافت تعاملی ورودی‌ها
       $ gh workflow run

       # اجرای فایل گردش‌کار 'triage.yml' در شاخه پیش‌فرض ریموت
       $ gh workflow run triage.yml

       # اجرای فایل گردش‌کار 'triage.yml' در یک مرجع (ref) مشخص
       $ gh workflow run triage.yml --ref my-branch

       # اجرای فایل گردش‌کار 'triage.yml' با ورودی‌های خط فرمان
       $ gh workflow run triage.yml -f name=scully -f greeting=hello

       # اجرای فایل گردش‌کار 'triage.yml' با JSON از طریق ورودی استاندارد
       $ echo '{"name":"scully", "greeting":"hello"}' | gh workflow run triage.yml --json




همچنین ببینید (SEE ALSO)
       gh-workflow(1)

                                   Sep 2026                 GH-WORKFLOW-RUN(1)