رفتن به محتوا
مستندات
نمای کلی CLI

نمای کلی CLI

مشاهده به‌صورت Markdown

CLI Status200، یعنی status200، پروژهٔ Status200 شما را از ترمینال یا یک اسکریپت مدیریت می‌کند. با یک کلید API از پروژه‌تان، مانیتورها، حادثه‌ها، هشدارها، صفحه‌های وضعیت و دیگر رکوردهایی را که API Status200 ارائه می‌دهد فهرست کنید، بخوانید، بسازید، تغییر دهید، حذف کنید و بشمارید.

CLI چگونه کار می‌کندیک دستور، یک درخواست API، یک پاسخ.نصب CLIیک دستور npm، و نسخه‌ای که باید انتخاب کنید.اجرای نخستین دستورهاکلید API خود را ذخیره کنید، سپس حادثه‌هایتان را فهرست کنید.نگاهی کلی به دستورهاهمهٔ دستورها، و صفحه‌ای که هر کدام را توضیح می‌دهد.

CLI چگونه کار می‌کند

هر دستور یک درخواست به REST API Status200 می‌فرستد و پاسخ را چاپ می‌کند. CLI کلید API و نشانی Status200 شما را از پرچم‌ها، متغیرهای محیطی یا زمینه‌ای که status200 login ذخیره کرده است برمی‌دارد. کلید تعیین می‌کند که یک دستور چه چیزی را می‌تواند بخواند و تغییر دهد، دقیقاً همان‌طور که برای API.

flowchart TB T["ترمینال شما<br/>یا یک جاب CI"] -->|"status200 incident list"| C["status200 CLI"] K["کلید API و URL:<br/>پرچم‌ها، متغیرهای محیطی<br/>یا زمینهٔ ذخیره‌شده"] --> C C -->|"POST /api/incident/get-list"| A["Status200 REST API"] A -->|"رکوردهایی که کلید<br/>می‌تواند بخواند، به‌صورت JSON"| C C -->|"جدول در ترمینال،<br/>JSON در پایپ"| T

یک دستور، یک درخواست

دستورهای رکوردها همراه CLI می‌آیند: هر نوع رکوردی که API Status200 به روی ابزارها باز می‌کند یک دستور دارد، همان رکوردهایی که سرور MCP برایشان ابزار دارد. برای فهرست کردن آن‌ها status200 resources را اجرا کنید.

پیش از شروع

  • Node.js و npm، یک نسخهٔ LTS فعلی، برای نصب CLI.
  • یک کلید API از پروژهٔ شما. آن را در تنظیمات پروژه > پیشرفته > کلیدهای API با ساخت کلید API بسازید: یک کلید API بسازید را ببینید.
  • در Status200 Cloud، طرح Growth یا بالاتر. کلیدهای API یک پروژه فقط روی آن کار می‌کنند: کلیدهای API و SCIM پایین‌تر از طرحشان را ببینید.

نصب CLI

بستهٔ @status200/cli را از npm نصب کنید. این بسته دستور status200 را اضافه می‌کند و --version نسخه‌ای را که نصب کرده‌اید چاپ می‌کند:

Bash 
npm install -g @status200/cli
status200 --version

CLI همراه با Status200 منتشر می‌شود و همان شمارهٔ نسخه را دارد. در Status200 خودمیزبان، CLI هم‌نسخهٔ Status200 خود را نصب کنید تا دستورهایش با رکوردهای سرور شما جور باشند:

Bash 
npm install -g @status200/cli@<your-oneuptime-version>

اجرای نخستین دستورها

  1. کلید API خود را ذخیره کنید

    با کلید و نشانی Status200 خود وارد شوید. CLI آن‌ها را به‌عنوان زمینه‌ای به نام default ذخیره می‌کند و از این پس از آن استفاده می‌کند:

    Bash 
    status200 login <your-api-key> https://status200.ru

    پاسخ آن Logged in successfully. Context "default" is now active. است. در Status200 خودمیزبان، به‌جای https://status200.ru نشانی آن را بنویسید.

  2. حادثه‌هایتان را فهرست کنید

    Bash 
    status200 incident list

    تازه‌ترین ده حادثه به‌صورت جدول نمایش داده می‌شوند. login کلید را بدون بررسی ذخیره می‌کند، پس این نخستین دستوری است که نشان می‌دهد کلید کار می‌کند: اگر رد شد، عیب‌یابی را ببینید.

  3. ببینید چه چیزهای دیگری را می‌توانید مدیریت کنید

    Bash 
    status200 resources

    این فهرست هر نوع رکوردی را که می‌توانید با آن کار کنید، همراه با دستورش نشان می‌دهد، مانند monitor، status-page یا on-call-policy.

نگاهی کلی به دستورها

دستورچه می‌کندبیشتر بخوانید
status200 login <api-key> <instance-url>یک کلید API و یک نشانی را به‌عنوان زمینه ذخیره می‌کنداحراز هویت
status200 context list, use, current, deleteزمینه‌های ذخیره‌شده را فهرست می‌کند، عوض می‌کند، نشان می‌دهد و حذف می‌کنداحراز هویت
status200 whoamiURL و کلید API را که دستور بعدی به کار می‌برد نشان می‌دهداحراز هویت
status200 deployیک استقرار، یا تغییری دیگر، را برای نمودارها و Status200 AI ثبت می‌کنداستقرارها و تغییرها
status200 <resource> list, get, create, update, delete, countبا یک نوع رکورد کار می‌کندعملیات روی منابع
status200 resourcesانواع رکورد را همراه با دستورهایشان فهرست می‌کندمرجع دستورها
status200 versionنسخهٔ CLI را چاپ می‌کندمرجع دستورها
status200 help [command]راهنمای یک دستور را نشان می‌دهدگرفتن راهنما

گزینه‌های سراسری

این گزینه‌ها با هر دستوری کار می‌کنند، پیش یا پس از آن:

گزینهچه می‌کند
--api-key <key>کلید API برای همین دستور، به‌جای کلید ذخیره‌شده
--url <url>نشانی Status200 شما برای همین دستور
--context <name>یک زمینهٔ ذخیره‌شده برای همین دستور، به‌جای زمینهٔ فعلی
-o, --output <format>table، json یا wide: قالب‌های خروجی را ببینید
--no-colorبدون رنگ چاپ می‌کند
-V, --versionنسخهٔ CLI را چاپ می‌کند
-h, --helpراهنمای دستور را نشان می‌دهد

گرفتن راهنما

هر دستور راهنمای خودش را دارد، با آرگومان‌ها، گزینه‌ها و مقادیر پیش‌فرضش:

Bash 
status200 --help
status200 help incident
status200 incident list --help

گام‌های بعدی

احراز هویتزمینه‌ای برای هر محیط، و این‌که یک دستور کدام کلید را به کار می‌برد.عملیات روی منابعرکوردها را فهرست کنید، بخوانید، بسازید، تغییر دهید، حذف کنید و بشمارید.قالب‌های خروجیجدول برای آدم‌ها، JSON برای اسکریپت‌ها.اسکریپت‌نویسی و CI/CDکدهای خروج، jq و خط لوله‌ها.مرجع دستورهاهمهٔ دستورها، گزینه‌ها و مقادیر پیش‌فرض.