- مستندات
- خط فرمان (CLI)
- امکانات عمومی سرویس CLI ستون
امکانات عمومی سرویس CLI ستون
در CLI ستون امکاناتی فراهم شده است تا کاربر بتواند با استفاده از آنها به راحتی و حتی بدون نیاز به استفاده از راهنمای کاربر از این ابزار استفاده کند که در ادامه به بررسی برخی از این دستورها و امکانات خواهیم پرداخت.
راهنمای دستورهای CLI ستون به شما این امکان را میدهد که در هر سطحی از سلسلهمراتب گروهها که هستید از انتخابهای موجود جهت سطح بعدی و کارکرد هر یک مطلع شوید. همچنین این امکان را به شما میدهد که برای هر دستور از رسمالخط، پارامترهای آن دستور، توضیح و جزئیات آنها اطلاعات کافی داشته باشید.
جهت استفاده از راهنمای دستورها، کافی است در هر سطحی از سلسله مراتب گروهها یا دستور نهایی، آن را بدون پارامتر یا با پارامتر --help وارد کنید. به عنوان مثال با استفاده از دستورهای زیر میتوانید انتخابها و گروههای موجود در ریشهی CLI ستون را مشاهده کنید.
و دستورهای زیر رسمالخط و توضیحات دستور sotoon/iam/users/add را به شما نمایش میدهند.
یکی از مسائلی که ممکن است تجربهی کاربری استفادهکننده از CLI را تحت تأثیر قرار دهد نیاز به مقداردهی چندبارهی پارامترهای مشترک میان دستورهای مختلف در زمان استفاده است. به عبارت دیگر، پارامترهایی وجود دارند که به دلیل ماهیت پایهای و بنیادی که دارند در معماری سرویسهای ستون بین همه یا تعداد بسیار زیادی از دستورها مشترک هستند و مقداردهی مجدد آنها در هر دستور میتواند آزاردهنده باشد. به عنوان مثال، پارامترهایی مثل توکن احراز هویت IAM و یا شناسهی فضای کاری (WorkSpace) از این جنس پارامترها هستند.
در CLI ستون امکانی قرار داده شده است که با استفاده از آن میتوان مقدار پیشفرض برای این دسته از پارامترها تعیین کرد و در صورتی که دستوری اجرا شود که پارامتری از آن توسط کاربر مقداردهی نشده و مقدار پیشفرض توسط کاربر برای آن تعیین شده باشد، آن مقدار پیشفرض برای پارامتر مربوطه در نظر گرفته خواهد شد.
به عنوان مثال، دستور زیر را در نظر بگیرید:
در این دستور لازم است که دو پارامتر workspace و token از کاربر دریافت شوند. در صورتی که کاربر بخواهد روی فضای کاری مشخصی فعالیت کند و جهت احراز هویت از توکن خاصی استفاده کند، میتواند با استفاده از دستور sotoon/config/set برای آنها مقدار پیشفرض تعیین کند:
پس از آن میتواند دستور ذکرشده را به این شکل و بدون نیاز به مقداردهی دو پارامتر workspace و token اجرا کند:
دستورهای list و get و unset نیز به ترتیب جهت گرفتن فهرست مقادیر، گرفتن یک مقدار خاص و حذف یک مقدار پیشفرض در گروه config وجود دارند.
هر دستور CLI ممکن است اطلاعاتی را به عنوان خروجی به کاربر برگرداند. این اطلاعات میتواند یک مقدار ساده، یک شیء پیچیده متشکل از تعدادی ویژگی/مقدار یا لیستی از مقادیر ساده یا اشیاء باشد. CLI ستون این امکان را به شما میدهد که بتوانید خروجی دستور موردنظر خود را با استفاده از پارامتر عمومی output با قالبهای مختلف دریافت کنید.
در ادامه قالبهایی که در حال حاضر توسط CLI ستون پشتیبانی میشوند با ذکر مثال آمده است:
دستور در قالب json-raw خروجی دستور را به صورت json خام و بدون هر گونه زیبا و خواناسازی برمیگرداند.
دستور در قالب json خروجی دستور را به صورت json زیبا و خواناسازیشده برمیگرداند.
دستور در قالب table خروجی دستور را به صورت یک جدول برمیگرداند.
دستور در قالب yaml خروجی دستور را در همین قالب برمیگرداند.
قالب پیشفرض نمایش خروجی دستورهای CLI ستون json است که با استفاده از پارامتری به نام output (با نام مخفف o) - که روی همه دستورهای CLI وجود دارد - میتوانید خروجی را در قالب موردنظر خود دریافت کنید. به عنوان مثال دستور زیر فهرست کاربران را در قالب جدولی به کاربر برمیگرداند:
پارامتر | کاربرد |
---|---|
–help | جهت استفاده از راهنمای دستورها، در هر سطحی از سلسله مراتب گروهها یا دستور نهایی |
set | تعیین مقدار پیشفرض پارامترها |
unset | حذف یک مقدار پیشفرض |
list | گرفتن فهرست مقادیر |
get | گرفتن یک مقدار خاص |