مرجع دستورات CLI

مدت زمان مطالعه: : 24 دقیقه

TestRail_CLI (Navy Logo).png

مرجع عمومی #

TRCLI یک ابزار خط فرمان برای خودکارسازی اقدامات در TestRail مانند ایجاد اجرای تست، آپلود نتایج یا تولید موارد از گزارش‌های خارجی است.

وقتی از این استفاده کنید:

شما می خواهید گردش کار QA را از اسکریپت های محلی یا خطوط لوله CI/CD خودکار کنید
شما می خواهید اقدامات سریعتر و قابل تکرار بدون نیاز به استفاده از TestRail UI انجام شود

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

trcli --help

که لیستی مانند زیر را بازیابی می کند:

TestRail CLI v1.1X.X
Copyright 2025 Gurock Software GmbH - www.gurock.com
Usage: trcli [OPTIONS] COMMAND [ARGS]...

  TestRail CLI

Options:
  -c, --config           Optional path definition for testrail-credentials
                         file or CF file.
  -h, --host             Hostname of instance.
  --project              Name of project the Test Run should be created under.
  --project-id           Project id. Will be only used in case project name
                         will be duplicated in TestRail  [x>=1]
  -u, --username         Username.
  -p, --password         Password.
  -k, --key              API key used for authenticating with TestRail. This
                         must be used in conjunction with --username. If
                         provided, --password is not required.
  -v, --verbose          Output all API calls and their results.
  --verify               Verify the data was added correctly.
  --insecure             Allow insecure requests.
  -b, --batch-size       Configurable batch size.  [default: (50); x>=2]
  -t, --timeout          Batch timeout duration.  [default: (60); x>=0]
  -y, --yes              answer 'yes' to all prompts around auto-creation
  -n, --no               answer 'no' to all prompts around auto-creation
  -s, --silent           Silence stdout
  --proxy                Proxy address and port (e.g.,
                         http://proxy.example.com:8080).
  --proxy-user           Proxy username and password in the format
                         'username:password'.
  --noproxy              Comma-separated list of hostnames to bypass the proxy
                         (e.g., localhost,127.0.0.1).
  --parallel-pagination  Enable parallel pagination for faster case fetching
                         (experimental).
  --help                 Show this message and exit.

Commands:
  add_run         Add a new test run in TestRail
  export_gherkin  Export BDD test case from TestRail as .feature file
  import_gherkin  Upload or update Gherkin .feature file in TestRail
  labels          Manage labels in TestRail
  parse_cucumber  Parse Cucumber JSON results and upload to TestRail
  parse_junit     Parse JUnit report and upload results to TestRail
  parse_openapi   Parse OpenAPI spec and create cases in TestRail
  parse_robot     Parse Robot Framework report and upload results to...
  references      Manage references in TestRail
  update          Update TRCLI to the latest version from PyPI.

گزینه های جهانی #

این گزینه ها را می توان با هر دستور TRCLI استفاده کرد.

گزینه	توضیحات
`-c, --config`	مسیر فایل کانفیگ (به عنوان مثال، `testrail-credentials.json`). برای ذخیره جزئیات ورود به سیستم مفید است تا در خط فرمان در معرض دید قرار نگیرند.
`-h, --host`	URL نمونه TestRail شما، مانند `https://yourcompany.testrail.io`. مورد نیاز.
`--project`	نام پروژه در TestRail برای ایجاد یا واکشی اجراها تحت پروژه داده شده استفاده می شود.
`--project-id`	شناسه پروژه، فقط زمانی استفاده می شود که چندین پروژه یک نام داشته باشند.
`-u, --username`	TestRail نام کاربری ورود به سیستم (معمولا ایمیل). لازم است مگر اینکه از فایل پیکربندی استفاده کنید.
`-p, --password`	TestRail رمز عبور. در صورت استفاده از کلید API اختیاری است.
`-k, --key`	کلید API برای احراز هویت ایمن استفاده با `--username`.
`-v, --verbose`	نمایش دهید سیاهههای مربوط به جزئیات، از جمله تماس ها و پاسخ های API. برای رفع اشکال مفید است.
`--verify`	تایید می کند که داده ها (مانند نتایج آزمون آپلود شده) به درستی اضافه شده است.
`--insecure`	اجازه دهید درخواست های HTTPS ناامن (از تأیید اعتبار SSL صرفنظر کنید). با احتیاط استفاده کنید.
`-b, --batch-size`	تعداد موارد برای پردازش هر دسته API. پیش فرض: ۵۰. افزایش برای آپلودهای بزرگ.
`-t, --timeout`	زمان انتظار (بر حسب ثانیه) بین دسته‌های API. پیش‌فرض: ۳۰. محدودیت‌های نرخ API را تنظیم کنید.
`-y, --yes`	به صورت خودکار پاسخ دهید “بله” به درخواست (به عنوان مثال، تست‌کیس‌ها ایجاد خودکار). مفید در CI/CD.
`-n, --no`	به صورت خودکار پاسخ دهید “نه” به درخواست ها. از ایجاد خودکار تست‌کیس‌ها مفقود شده جلوگیری می کند.
`-s, --silent`	همه را سرکوب کنید خروجی استاندارد (stdout).
`--proxy`	استفاده از a سرور پروکسی (به عنوان مثال، `http://proxy.company.com:8080`).
`--proxy-user`	پروکسی اعتبارنامه در `username:password` قالب
`--noproxy`	لیست جدا شده با کاما از میزبان برای دور زدن پروکسی (به عنوان مثال، `localhost,127.0.0.1`).
`--help`	نمایش کمک برای دستور.

خلاصه دستورات #

فرمان	کاری که انجام می دهد
`add_run`	a را ایجاد می کند اجرای تست جدید در TestRail
`labels`	مدیریت کنید برچسب ها در TestRail
`export_gherkin`	تست‌کیس BDD را صادر کنید از TestRail به عنوان فایل ویژگی
`import_gherkin`	آپلود کنید یا آپدیت قرقره فایل .feature در TestRail
`parse_cucumber`	پارسس الف گزارش JSON خیار و نتایج را در TestRail بارگذاری می کند.
`parse_junit`	پارسس الف گزارش JUnit و نتایج را در TestRail بارگذاری می کند.
`parse_openapi`	یک را تجزیه می کند مشخصات OpenAPI و تست‌کیس‌ها ایجاد می کند.
`parse_robot`	پارسس الف چارچوب ربات گزارش تست و نتایج آپلود
`references`	مدیریت مراجع برای تست‌کیس‌ها در TestRail
`update`	TRCLI را به آخرین نسخه از PyPI به روز کنید.

یک اجرای تست جدید در TestRail ایجاد کنید #

استفاده کنید trcli add_run هنگامی که می خواهید یک اجرای تست در TestRail ایجاد کنید – چه برای اجرای دستی یا قبل از آپلود نتایج خودکار. همچنین می‌توانید از آن برای تعریف زمان‌بندی، اختصاص آزمایش‌کننده‌ها یا برچسب‌گذاری اجرا با مراجع یا الزامات استفاده کنید.

این برای:

مدیران QA یا آزمایش کنندگان برنامه ریزی از قبل کار می کنند
مهندسان اتوماسیون قبل از بارگذاری نتایج به یک شناسه اجرا نیاز دارند
تیم‌ها اجراهای آزمایشی را با الزامات، نقاط عطف یا تاریخ‌های سرعت همسو می‌کنند

مثال #

trcli add_run \
  --title "Release 2.3 Regression" \
  --suite-id 7 \
  --milestone-id 14 \
  --run-start-date "08/01/2025" \
  --run-end-date "08/05/2025" \
  --run-include-all \
  --run-refs REQ-101,REQ-202 \
  --run-assigned-to-id 3

این دستور یک اجرای تست با عنوان تحت مجموعه ID ۷ ایجاد می‌کند که به یک نقطه عطف مرتبط است، با محدوده تاریخ زمان‌بندی‌شده و شامل تمام تست‌کیس‌ها. اجرا به یک تستر خاص اختصاص داده شده است و به دو مورد نیاز اشاره دارد.

گزینه های موجود #

TestRail CLI v1.1X.X
Copyright 2025 Gurock Software GmbH - www.gurock.com
Usage: trcli add_run [OPTIONS]

  Add a new test run in TestRail

Options:
  --title                     Title of Test Run to be created or updated in
                              TestRail.
  --run-id                    ID of existing test run to update. If not
                              provided, a new run will be created.  [x>=1]
  --suite-id                  Suite ID to submit results to.  [x>=1]
  --run-description           Summary text to be added to the test run.
  --milestone-id              Milestone ID to which the Test Run should be
                              associated to.  [x>=1]
  --run-start-date            The expected or scheduled start date of this
                              test run in MM/DD/YYYY format
  --run-end-date              The expected or scheduled end date of this test
                              run in MM/DD/YYYY format
  --run-assigned-to-id        The ID of the user the test run should be
                              assigned to.  [x>=1]
  --clear-run-assigned-to-id  Clear the assignee of the test run (only valid
                              when updating with --run-id).
  --run-include-all           Use this option to include all test cases in
                              this test run.
  --auto-close-run            Use this option to automatically close the
                              created run.
  --run-case-ids              Comma separated list of test case IDs to include
                              in the test run (i.e.: 1,2,3,4).
  --run-refs                  A comma-separated list of
                              references/requirements (up to 250 characters)
  --run-refs-action           Action to perform on references: 'add'
                              (default), 'update' (replace all), or 'delete'
                              (remove all or specific)
  -f, --file                  Write run data to file.
  --help                      Show this message and exit.

گزینه	توضیحات
`--title`	نام اجرای تست، در رابط کاربری TestRail نشان داده شده است (به عنوان مثال، “Sprint ۳۴ Regression”).
`--run-id`	شناسه از اجرای تست موجود برای به روز رسانی. اگر ارائه نشود، اجرای جدید ایجاد خواهد شد.
`--suite-id`	را شناسه مجموعه آزمایشی برای مرتبط کردن اجرا با. اگر پروژه شما از چندین مجموعه استفاده می کند، ضروری است.
`--run-description`	الف خلاصه یا یادداشت برای دویدن برای روشن کردن محدوده یا اهداف خوب است.
`--milestone-id`	این اجرا را به یک برنامه خاص پیوند دهید شناسه نقطه عطف (به عنوان مثال، انتشار یا سرعت).
`--run-start-date`	مورد انتظار یا برنامه ریزی شده تاریخ شروع، در `MM/DD/YYYY` قالب
`--run-end-date`	مورد انتظار یا برنامه ریزی شده تاریخ پایان برای دویدن
`--run-assigned-to-id`	این اجرا را به یک خاص اختصاص دهید کاربر بر اساس شناسه (یعنی آزمایش کننده اصلی مسئول).
`--clear-run-assigned-to-id`	تکلیف اجرای تست را پاک کنید. توجه: فقط هنگام به روز رسانی با –run-id معتبر است (فقط برای نسخه TR ۱۰.۲ و بالاتر)
`--run-include-all`	شامل شود تمام تست‌کیس‌ها از مجموعه در این اجرا. قابل استفاده با `--run-case-ids`.
`--auto-close-run`	به طور خودکار بسته می شود اجرای تست که ایجاد شد. استفاده از آن ساده است، فقط این دستور را به انتهای اسکریپت اضافه کنید.
`--run-case-ids`	فهرستی از شناسه های تست‌کیس خاص گنجاندن (به عنوان مثال `101,102,103`).
`--run-refs`	لیست جدا شده با کاما از ارجاعات خارجی یا شناسه های مورد نیاز (به عنوان مثال، `REQ-101,REQ-202`).
`-f, --file`	داده های اجرای تولید شده را در محلی بنویسید فایل به جای ارسال آن برای پیش نمایش یا ممیزی مفید است.
`--help`	اطلاعات راهنما را برای این دستور نشان دهید.

نکات #

اگر می خواهید اجرا را به موارد خاص محدود کنید، استفاده کنید --run-case-ids.
برای کارهای برنامه ریزی شده، مدیران QA می توانند a را تعریف کنند تاریخ شروع/پایان برای دید
اگر شما هستید خودکار کردن آپلودهای آزمایشی، می توانید اجرا را در اینجا ایجاد کنید و بعداً استفاده کنید parse_junit با --run-id.

برچسب‌ها را به تست‌کیس‌ها اضافه کنید #

را labels دستور به شما امکان می دهد برچسب ها را در TestRail ایجاد، به روز رسانی، حذف و مدیریت کنید. برچسب‌ها برای سازمان‌دهی موارد آزمایش، گروه‌بندی آزمایش‌های مرتبط، و امکان فیلتر کردن آسان‌تر در حین گزارش مفید هستند.

این دستور با شروع در دسترس است TestRail CLI نسخه ۱.۱۲.۰.

مثال #

## assign a label to a case
trcli labels cases add --project-id <PROJECT_ID> --case-id <CASE_ID> --label "Regression"

## delete a lable from a case
trcli labels delete --project-id <PROJECT_ID> --id <LABEL_ID>

## gets details of a specific label
trcli labels get --project-id <PROJECT_ID> --id <LABEL_ID>

## list all the labels from a specific project
trcli labels list --project-id <PROJECT_ID>

## update an existing label
trcli labels update --project-id <PROJECT_ID> --id <LABEL_ID> --name "Updated Label Name"

گزینه های موجود #

TestRail CLI v1.12.0
Copyright 2025 Gurock Software GmbH - www.gurock.com
Usage: trcli labels [OPTIONS] COMMAND [ARGS]...

  Manage labels in TestRail

Options:
  --help  Show this message and exit.

Commands:
  add     Add a new label in TestRail
  cases   Manage labels for test cases
  delete  Delete labels from TestRail
  get     Get a specific label by ID
  list    List all labels in the project
  update  Update an existing label in TestRail

گزینه	توضیحات
`add`	یک برچسب جدید در TestRail اضافه کنید.
`cases`	برچسب‌ها را برای تست‌کیس‌ها مدیریت کنید (تخصیص یا لغو تخصیص).
`delete`	برچسب ها را از TestRail حذف کنید.
`get`	جزئیات یک برچسب خاص را با شناسه دریافت کنید.
`list`	همه برچسب ها را در یک پروژه مشخص لیست کنید.
`update`	یک برچسب موجود در TestRail را به روز کنید.

زمان استفاده از برچسب ها #

سازمان – تست‌کیس‌ها را بر اساس ویژگی، ماژول یا چرخه انتشار گروه بندی کنید.
فیلتر کردن – به راحتی گزارش ها و آزمایش ها را بر اساس برچسب فیلتر کنید.
اتوماسیون – برچسب ها را به طور خودکار برای دسته بندی آزمایش ها در طول خطوط لوله CI/CD اختصاص دهید.

نتایج JUnit را بارگذاری کنید #

یک گزارش JUnit XML (متداول در تست های خودکار) را تجزیه می کند و نتایج را در TestRail بارگذاری می کند.

استفاده کنید parse_junit a تجزیه کردن گزارش JUnit XML و نتایج تست را در TestRail آپلود کنید. این معمولاً در خطوط لوله CI/CD یا پس از اجرای آزمایش خودکار استفاده می شود.

وقتی از این استفاده می کنید:

شما آزمایشات خودکار را اجرا کرده اید (مانند JUnit، TestNG، Selenium)
شما می خواهید نتایج به طور مستقیم در TestRail آپلود شوند
می‌خواهید موارد گمشده را به‌طور خودکار ایجاد کنید یا یک اجرای تست موجود را به‌روزرسانی کنید

را test_id دارایی در JUnit <testcase> می تواند ارجاع دهد یک یا چند شناسه کیس TestRail.

هنگامی که شناسه های چندگانه (به عنوان یک لیست جدا شده با کاما) ارائه می شود، TestRail CLI ایجاد می کند یک نتیجه فردی برای هر مورد ارجاع شده در اجرای تست هدف

مثال #

trcli parse_junit \
  -f build/test-results/test/TEST-results.xml \
  --project "Mobile App" \
  --title "Regression Test - Aug 1" \
  --suite-id 10 \
  --milestone-id 22 \
  --case-matcher "name" \
  --update-existing-cases yes \
  --test-run-ref "PROJ-123,PROJ-456"
  --close-run

این فرمان نتایج یک فایل JUnit XML را آپلود می‌کند، یک اجرای تست تحت مجموعه داده‌شده ایجاد می‌کند، آن را با یک نقطه عطف مرتبط می‌کند، موارد آزمایش را بر اساس عنوان مطابقت می‌دهد، و اجرا را پس از آن می‌بندد.

گزینه های موجود #

TestRail CLI v1.1X.X
Copyright 2025 Gurock Software GmbH - www.gurock.com
Usage: trcli parse_junit [OPTIONS]

  Parse JUnit report and upload results to TestRail

Options:
  -f, --file                Filename and path.
  --close-run               Close the newly created run
  --title                   Title of Test Run to be created or updated in
                            TestRail.
  --case-matcher            Mechanism to match cases between the report and
                            TestRail.
  --suite-id                Suite ID to submit results to.  [x>=1]
  --suite-name              Suite name to submit results to.
  --run-id                  Run ID for the results they are reporting
                            (otherwise the tool will attempt to create a new
                            run).  [x>=1]
  --plan-id                 Plan ID with which the Test Run will be
                            associated.  [x>=1]
  --config-ids              Comma-separated configuration IDs to use along
                            with Test Plans (i.e.: 34,52).
  --milestone-id            Milestone ID to which the Test Run should be
                            associated to.  [x>=1]
  --section-id              Section ID to create new sections with test cases
                            under (optional).  [x>=1]
  --run-description         Summary text to be added to the test run.
  --case-fields             List of case fields and values for new test cases
                            creation. Usage: --case-fields type_id:1 --case-
                            fields priority_id:3
  --result-fields           List of result fields and values for test results
                            creation. Usage: --result-fields
                            custom_field_a:value1 --result-fields
                            custom_field_b:3
  --allow-ms                Allows using milliseconds for elapsed times.
  --special-parser          Optional special parser option for specialized
                            JUnit reports.
  -a, --assign              Comma-separated list of user emails to assign
                            failed test results to.
  --test-run-ref            Comma-separated list of reference IDs to append to
                            the test run (up to 250 characters total).
  --json-output             Output reference operation results in JSON format.
  --update-existing-cases   Update existing TestRail cases with values from
                            JUnit properties (default: no).
  --update-strategy         Strategy for combining incoming values with
                            existing case field values, whether to append or
                            replace (default: append).
  --help                    Show this message and exit.

گزینه	توضیحات
`-f, --file`	مسیر به فایل گزارش JUnit XML. مورد نیاز.
`--close-run`	به صورت خودکار اجرای تست را می بندد پس از آپلود نتایج
`--title`	عنوان اجرای تست که باید ایجاد یا به‌روزرسانی شود. در رابط کاربری TestRail ظاهر می شود.
`--case-matcher`	چگونه به تست‌کیس‌ها را مطابقت دهید بین گزارش JUnit و TestRail (به عنوان مثال، بر اساس عنوان، شناسه، یا ویژگی های سفارشی).
`--suite-id`	شناسه مجموعه برای گزارش نتایج. مورد نیاز برای پروژه های چند سوئیتی.
`--suite-name`	جایگزین برای `--suite-id`. نام مجموعه برای مرتبط با اجرا.
`--run-id`	شناسه یک اجرای تست موجود برای به روز رسانی به جای ایجاد یک مورد جدید.
`--plan-id`	اجرای تست را به a وصل کنید طرح تست (اگر در حال سازماندهی اجراها تحت یک طرح گسترده تر هستید).
`--config-ids`	لیست جدا شده با کاما از شناسه های پیکربندی برای ارتباط با اجرا (به عنوان مثال، سیستم عامل، مرورگر).
`--milestone-id`	شناسه Milestone برای مرتبط کردن اجرا (به عنوان مثال، “Sprint ۱۴” یا “Release ۲.۱”).
`--section-id`	بخشی که تحت آن تست‌کیس‌ها جدید باید ایجاد شود (در صورت وجود).
`--run-description`	a اضافه کنید توضیحات یا یادداشت ها به اجرای تست برای زمینه مفید است.
`--case-fields`	سفارشی تنظیم کنید مقادیر فیلد برای هر تست‌کیس جدید ایجاد شده (به عنوان مثال، نوع، اولویت). استفاده: `--case-fields priority_id:3`
`--result-fields`	سفارشی تنظیم کنید مقادیر فیلد برای هر نتیجه آزمایش (به عنوان مثال، محیط آزمایش، یادداشت ها). استفاده: `--result-fields custom_status:passed`
`--allow-ms`	به گزارش اجازه استفاده می دهد میلی ثانیه در زمان های سپری شده
`--special-parser`	استفاده از a منطق تجزیه سفارشی برای فرمت های غیر استاندارد JUnit.
`-a, --assign`	تمام تست های ناموفق در یک اجرا به طور خودکار به کاربر مشخص شده اختصاص داده می شود.
`--test-run-ref`	فهرست شناسه‌های مرجع جدا شده با کاما برای الحاق به اجرای تست (در مجموع تا ۲۵۰ کاراکتر). استفاده: `--test-run-ref "TCM-77,TCM-77,TCM-78,TCM-79"`
`--json-output`	نتایج عملیات مرجع خروجی در قالب JSON.
`--update-existing-cases`	چه زمانی `“yes”`، parse_junit به‌روزرسانی‌های فیلد موردی پشتیبانی شده را برای موارد موجود منطبق اعمال می‌کند – به طور پیش‌فرض: خیر
`--update-strategy`	نحوه ترکیب مقادیر ورودی با مقادیر موجود برای فیلد را کنترل می کند. ارزش ها: `append` → فقط ارجاعات را به پرونده آزمایشی اضافه می کند `replacee → replace the references of the test cases entirely` به طور پیش فرض: ضمیمه
`--help`	نمایش استفاده از دستور و خروج.

نگاشت یک نتیجه آزمایشی به چندین مورد TestRail #

یک تست‌کیس JUnit را می توان با استفاده از موارد متعدد TestRail نگاشت کرد test_id دارایی

<testcase classname="tests.LoginTests" name="test_login_flow">
  <properties>
    <property name="test_id" value="C101, C102, C103"/>
  </properties>
</testcase>

هنگامی که نتایج توسط trcli parse_junit:

CLI فهرست شناسه‌های مورد جدا شده با کاما را می‌خواند
هر مورد یک ورودی نتیجه فردی
همه موارد نقشه برداری شده دریافت می کنند وضعیت نتیجه یکسان از تست اتوماسیون

این به یک تست خودکار اجازه می‌دهد تا چندین کیس TestRail را در حین نگهداری به‌روزرسانی کند ردیابی نتایج جداگانه برای هر مورد.

نکات #

استفاده کنید --run-id اگر قبلاً با استفاده از یک اجرای تست ایجاد کرده اید add_run.
استفاده کنید --case-matcher برای پیوند دادن نتایج به تست‌کیس‌ها موجود، اجتناب از تکرار.
جفت کردن --plan-id و --config-ids اگر ماتریس های آزمایشی را مدیریت می کنید (به عنوان مثال، ترکیب های پلت فرم/مرورگر).
--result-fields می تواند متادیتا مانند نسخه های ساخت یا لینک های نقص را ضبط کند.
-a, --assign خروجی مشابه زیر را بازیابی می کند: Assigning failed results: 1/1, Done.

تست‌کیس‌ها را از یک OpenAPI Spec ایجاد کنید #

از این دستور برای ایجاد خودکار تست‌کیس‌ها در TestRail بر اساس مشخصات OpenAPI (Swagger سابق) استفاده کنید. این برای ساخت سریع پوشش آزمایشی برای REST API ایده آل است.

شما از این استفاده می کنید اگر:

شما در حال راه‌اندازی یک API جدید هستید و می‌خواهید ایجاد کیس آزمایشی را بوت استرپ کنید
شما می خواهید تست‌کیس‌ها ساختار یافته برای نقاط پایانی (GET/POST/و غیره) بر اساس یک فایل مشخصات
شما می خواهید پوشش آزمایشی را با طراحی API خود هماهنگ کنید

مثال #

trcli parse_openapi \
  -f specs/user-api.yaml \
  --suite-id 5 \
  --case-fields type_id:1 \
  --case-fields priority_id:3

این خوانده می شود user-api.yaml، تست‌کیس‌ها را در مجموعه ID تولید می کند 5و مقادیر نوع و اولویت را برای هر مورد جدید تنظیم می کند.

گزینه های موجود #

TestRail CLI v1.1X.X
Copyright 2025 Gurock Software GmbH - www.gurock.com
Usage: trcli parse_openapi [OPTIONS]

  Parse OpenAPI spec and create cases in TestRail

Options:
  -f, --file      Filename and path.
  --suite-id      Suite ID to create the tests in (if project is multi-suite).
                  [x>=1]
  --case-fields   List of case fields and values for new test cases creation.
                  Usage: --case-fields type_id:1 --case-fields priority_id:3
  --help          Show this message and exit.

گزینه	توضیحات
`-f, --file`	مسیر به فایل OpenAPI YAML یا JSON (به عنوان مثال، `api-spec.yaml`). مورد نیاز.
`--suite-id`	شناسه مجموعه که در آن تست‌کیس‌ها باید ایجاد شود. مورد نیاز برای پروژه های چند سوئیتی.
`--case-fields`	یک یا چند مقادیر فیلد سفارشی برای اعمال در هر تست‌کیس. از قالب استفاده کنید: `field_id:value`. می توانید گزینه تنظیم چند فیلد را تکرار کنید.
`--help`	نمایش استفاده از دستور و خروج.

نکات #

استفاده کنید --case-fields برای برچسب گذاری موارد با نوع آزمایش، وضعیت اتوماسیون یا اولویت.
اگر پروژه شما فقط از یک مجموعه واحد استفاده می کند، می توانید از آن صرف نظر کنید --suite-id.
موارد ایجاد شده از فیلدهای سفارشی TestRail و تنظیمات قالب پیروی می کنند.

نتایج Robot Framework را بارگذاری کنید #

از این دستور برای آپلود نتایج از a استفاده کنید اجرای تست Robot Framework (معمولا یک output.xml فایل) به TestRail.

زمانی از آن استفاده کنید:

شما از Robot Framework برای اتوماسیون تست استفاده می کنید
شما می خواهید نتایج به طور خودکار در TestRail منعکس شود
می‌خواهید تست‌کیس‌ها را به‌طور خودکار ایجاد کنید یا نتایج را به اجراها/طرح‌های موجود پیوند دهید

مثال #

trcli parse_robot \
  -f output.xml \
  --project "Hardware QA" \
  --suite-name "Peripheral Tests" \
  --title "Regression - Aug 1" \
  --milestone-id 12 \
  --close-run \
  --case-matcher title

این دستور نتایج تست را از آن آپلود می کند output.xml، یک اجرای تست را در مجموعه “آزمون های جانبی” ایجاد می کند، آن را به نقطه عطف پیوند می دهد، موارد را بر اساس عنوان مطابقت می دهد و اجرا را پس از آن می بندد.

گزینه های موجود #

TestRail CLI v1.1X.X
Copyright 2025 Gurock Software GmbH - www.gurock.com
Usage: trcli parse_robot [OPTIONS]

  Parse Robot Framework report and upload results to TestRail

Options:
  -f, --file          Filename and path.
  --close-run         Close the newly created run
  --title             Title of Test Run to be created or updated in TestRail.
  --case-matcher      Mechanism to match cases between the report and
                      TestRail.
  --suite-id          Suite ID to submit results to.  [x>=1]
  --suite-name        Suite name to submit results to.
  --run-id            Run ID for the results they are reporting (otherwise the
                      tool will attempt to create a new run).  [x>=1]
  --plan-id           Plan ID with which the Test Run will be associated.
                      [x>=1]
  --config-ids        Comma-separated configuration IDs to use along with Test
                      Plans (i.e.: 34,52).
  --milestone-id      Milestone ID to which the Test Run should be associated
                      to.  [x>=1]
  --section-id        Section ID to create new sections with test cases under
                      (optional).  [x>=1]
  --run-description   Summary text to be added to the test run.
  --case-fields       List of case fields and values for new test cases
                      creation. Usage: --case-fields type_id:1 --case-fields
                      priority_id:3
  --result-fields     List of result fields and values for test results
                      creation. Usage: --result-fields custom_field_a:value1
                      --result-fields custom_field_b:3
  --allow-ms          Allows using milliseconds for elapsed times.
  --help              Show this message and exit.

گزینه	توضیحات
`-f, --file`	مسیر به فایل نتایج Robot Framework XML (معمولا `output.xml`). مورد نیاز.
`--close-run`	به صورت خودکار اجرای تست را ببندید پس از آپلود نتایج
`--title`	سفارشی عنوان برای اجرای تست (در TestRail نشان داده شده است).
`--case-matcher`	چگونگی را تعریف می کند تست‌کیس‌ها را مطابقت دهید در TestRail (به عنوان مثال، بر اساس عنوان، شناسه).
`--suite-id`	شناسه مجموعه برای ارسال نتایج. مورد نیاز برای پروژه های چند سوئیتی.
`--suite-name`	نام سوئیت جایگزینی برای `--suite-id`.
`--run-id`	شناسه یک اجرای تست موجود برای به روز رسانی اگر حذف شود، اجرای جدید ایجاد می شود.
`--plan-id`	اجرا را به a وصل کنید طرح تست (اختیاری).
`--config-ids`	با کاما جدا شده است شناسه های پیکربندی (به عنوان مثال، محیط هایی مانند Chrome/Linux).
`--milestone-id`	اجرا را به a پیوند دهید شناسه نقطه عطف (به عنوان مثال، یک سرعت یا انتشار).
`--section-id`	تست‌کیس‌ها جدید تحت یک خاص ایجاد کنید شناسه بخش (به ساختار کمک می کند).
`--run-description`	a اضافه کنید خلاصه یا یادداشت به اجرای تست
`--case-fields`	تنظیم کنید مقادیر فیلد برای تست‌کیس‌ها جدید، مانند نوع یا اولویت (به عنوان مثال، `type_id:1`).
`--result-fields`	تنظیم کنید مقادیر فیلد برای نتایج تست، مانند وضعیت سفارشی، مدت زمان یا یادداشت ها.
`--allow-ms`	اجازه می دهد مدت زمان در گزارش شود میلی ثانیه (مفید برای زمان بندی دقیق).
`--help`	نمایش راهنمای فرمان و خروج.

نکات #

استفاده کنید --case-matcher برای جلوگیری از ایجاد موارد تکراری
ترکیب کنید --plan-id و --config-ids هنگام ادغام با طرح ها و تنظیمات تست.
استفاده کنید --run-id برای به روز رسانی یک اجرا که قبلا از طریق add_run.

مدیریت مراجع #

را references دستور به شما امکان می دهد مراجع نیاز خارجی مرتبط با تست‌کیس‌ها TestRail خود را مستقیماً از خط فرمان مدیریت کنید.

این زمانی مفید است که نیاز به پیوند یا به‌روزرسانی شناسه‌های مورد نیاز (به‌عنوان مثال، بلیط‌های Jira، مشخصات الزامی) در چندین تست‌کیس به صورت انبوه داشته باشید – بدون نیاز به باز کردن هر تست‌کیس در TestRail UI.

می توانید استفاده کنید trcli references به:

پیوندهای داستان Jira را اضافه کنید (REQ-123، STORY-456) به تست‌کیس‌ها موجود.
منابع قدیمی را به صورت انبوه حذف کنید.
هنگامی که مشخصات محصول تغییر می کند، برچسب های الزامی قدیمی را با برچسب های جدید جایگزین کنید.

این ویژگی به ویژه برای تیم هایی مفید است که TestRail را با ابزارهای ردیابی نیازهای خارجی ادغام می کنند یا قابلیت ردیابی را در چندین پروژه QA حفظ می کنند.

پیش نیازها #

قبل از اجرای دستورات مرجع:

باید داشته باشی TestRail CLI نصب و پیکربندی شد با اعتبار API معتبر
باید داشته باشی دسترسی ویرایش به پروژه TestRail و تست‌کیس‌ها.
بشناسید شناسه های تست‌کیس و مقادیر مرجع شما می خواهید مدیریت کنید

نمای کلی فرمان #

TestRail CLI v1.xx.x
Copyright 2025 Gurock Software GmbH - www.gurock.com
Usage: trcli references cases [OPTIONS] COMMAND [ARGS]...

  Manage references for test cases

Options:
  --help  Show this message and exit.

Commands:
  add     Add references to test cases
  delete  Delete all or specific references from test cases
  update  Update references on test cases by replacing existing ones

فرمان	توضیحات
`add`	یک یا چند مرجع را به تست‌کیس‌ها خاص اضافه کنید.
`delete`	موارد خاص یا همه مراجع را از تست‌کیس‌ها حذف کنید.
`update`	مراجع موجود در تست‌کیس‌ها را با موارد جدید جایگزین کنید.

۱. منابع را به تست‌کیس‌ها اضافه کنید #

یک یا چند مرجع الزامی را به تست‌کیس‌ها مشخص شده اضافه می کند.

trcli references cases add --case-ids <CASE_IDS> --refs <REFERENCES>

سینتکس مک (zsh/bash) و ویندوز (PowerShell) یکسان است.

مثال #

# Add requirement IDs REQ-101 and REQ-102 to test cases 5 and 6
trcli references cases add --case-ids 5,6 --refs REQ-101,REQ-102

پارامترها #

TestRail CLI v1.xx.x1
Copyright 2025 Gurock Software GmbH - www.gurock.com
Usage: trcli references cases add [OPTIONS]

  Add references to test cases

Options:
  --case-ids   Comma-separated list of test case IDs (e.g., 1,2,3).
               [required]
  --refs       Comma-separated list of references to add (e.g., REQ-1,REQ-2).
               [required]
  --help       Show this message and exit.

گزینه	مورد نیاز	توضیحات
`--case-ids`	بله	فهرست شناسه‌های تست‌کیس جدا شده با کاما (به عنوان مثال، `1,2,3`).
`--refs`	بله	فهرست ارجاعات جدا شده با کاما برای افزودن (به عنوان مثال، `REQ-1,REQ-2`).

۲. منابع را از تست‌کیس‌ها حذف کنید #

ارجاعات خاص را از تست‌کیس‌ها حذف می کند، یا اگر هیچ کدام مشخص نشده باشد، همه مراجع را حذف می کند.

فرمان #

trcli references cases delete --case-ids <CASE_IDS> [--refs <REFERENCES>] [--yes]

مثال #

# Delete references REQ-101 and REQ-102 from test cases 5 and 6
trcli references cases delete --case-ids 5,6 --refs REQ-101,REQ-102

# Delete all references from test cases 5 and 6 (confirmation required)
trcli references cases delete --case-ids 5,6

⚠️ هشدار: بدون --refs، همه مراجع برای تست‌کیس‌ها مشخص شده حذف خواهند شد.
استفاده کنید --yes برای رد شدن از درخواست تأیید در اسکریپت های خودکار.

پارامترها #

TestRail CLI v1.xx.x
Copyright 2025 Gurock Software GmbH - www.gurock.com
Usage: trcli references cases delete [OPTIONS]

  Delete all or specific references from test cases

Options:
  --case-ids   Comma-separated list of test case IDs (e.g., 1,2,3).
               [required]
  --refs       Comma-separated list of specific references to delete. If not
               provided, all references will be deleted.
  --yes        Confirm the action without prompting.
  --help       Show this message and exit.

گزینه	مورد نیاز	توضیحات
`--case-ids`	بله	فهرست شناسه‌های تست‌کیس جدا شده با کاما (به عنوان مثال، `1,2,3`).
`--refs`	خیر	فهرستی از مراجع خاص برای حذف با کاما جدا شده است. در صورت حذف، همه مراجع حذف خواهند شد.
`--yes`	خیر	به طور خودکار حذف را تأیید کنید (مفید برای اسکریپت های CI/CD).

۳. به روز رسانی مراجع در تست‌کیس #

توضیحات #

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

trcli references cases update --case-ids <CASE_IDS> --refs <REFERENCES>

مثال #

# Replace all references on test cases 5 and 6 with REQ-200 and REQ-201
trcli references cases update --case-ids 5,6 --refs REQ-200,REQ-201

💡 نکته: از این دستور برای انجام به‌روزرسانی‌های کنترل‌شده زمانی که شناسه‌های نیازمندی سازماندهی یا تغییر نام می‌کنند، استفاده کنید.

پارامترها #

TestRail CLI v1.xx.x
Copyright 2025 Gurock Software GmbH - www.gurock.com
Usage: trcli references cases update [OPTIONS]

  Update references on test cases by replacing existing ones

Options:
  --case-ids   Comma-separated list of test case IDs (e.g., 1,2,3).
               [required]
  --refs       Comma-separated list of references to replace existing ones
               (e.g., REQ-1,REQ-2).  [required]
  --help       Show this message and exit.

گزینه	مورد نیاز	توضیحات
`--case-ids`	بله	فهرست شناسه‌های تست‌کیس جدا شده با کاما (به عنوان مثال، `1,2,3`).
`--refs`	بله	فهرست منابع جدید با کاما جدا شده برای جایگزینی منابع موجود.

🎓 سطح مهارت های تست خود را با آکادمی تست ریل!
دوره‌های رایگان و خودسرانه را کاوش کنید تا بیشترین بهره را از TestRail ببرید.

👉 همین الان شروع به یادگیری کنید

از کجا کمک بگیریم #

به‌روزرسانی شده در 1405-04-15

احساسات شما چیست؟

خوشحال
عادی
ناراحت

دیدگاهتان را بنویسید لغو پاسخ

برای نوشتن دیدگاه باید وارد بشوید.

مرجع عمومی #

گزینه های جهانی #

خلاصه دستورات #

یک اجرای تست جدید در TestRail ایجاد کنید #

مثال #

گزینه های موجود #

نکات #

برچسب‌ها را به تست‌کیس‌ها اضافه کنید #

مثال #

گزینه های موجود #

زمان استفاده از برچسب ها #

نتایج JUnit را بارگذاری کنید #

مثال #

گزینه های موجود #

نگاشت یک نتیجه آزمایشی به چندین مورد TestRail #

نکات #

تست‌کیس‌ها را از یک OpenAPI Spec ایجاد کنید #

مثال #

گزینه های موجود #

نکات #

نتایج Robot Framework را بارگذاری کنید #

مثال #

گزینه های موجود #

نکات #

مدیریت مراجع #

پیش نیازها #

نمای کلی فرمان #

۱. منابع را به تست‌کیس‌ها اضافه کنید #

مثال #

پارامترها #

۲. منابع را از تست‌کیس‌ها حذف کنید #

فرمان #

مثال #

پارامترها #

۳. به روز رسانی مراجع در تست‌کیس #

توضیحات #

مثال #

پارامترها #

از کجا کمک بگیریم #

این مقاله را به اشتراک بگذارید:

دیدگاهتان را بنویسید لغو پاسخ

تست ریل

مطالب مفید

حساب کاربری ندارید؟

ورود