چگونه از دستور Get-Help در پاورشل استفاده کنیم؟
پاورشل یک پوسته خط فرمان و اسکریپت نویسی قدرتمند و همه کاره است که توسط مایکروسافت توسعه یافته است. برای اینکه از پتانسیل کامل این ابزار بهره مند شوید، اول باید با کاربرد cmdlet ها و فانکشن های آن آشنا شوید. اینجاست که دستور Get-Help وارد عمل می شود.
دستور Get-Help حکم یک دفترچه راهنما را دارد که برای ارائه داکیومنتیشن کمکی تمام المان های پاورشل طراحی شده است. پس اگر در مورد cmdlet ها، توابع، ماژول ها، متغیرها و … نیاز به راهنمایی داشته باشید می توانید از این دستور کمک بگیرید.
* cmdlet یا کامندلت در پاورشل به دستوری گفته می شود که با استفاده از آنها می توان توابع ساده تا پیشرفته را اجرا کرد.
برای آشنایی با نحوه استفاده از دستور Get-Help در پاورشل با ادامه مقاله همراه باشید:
دستور Get-Help در پاورشل
کاربرانی که آشنایی زیادی با پاورشل ندارند با استفاده از دستور Get-Help می توانند یک نفس راحت بکشند. این دستور راهنمایی های لازم در مورد نحوه استفاده از تمام دستورات و پارامترهای هر کدام از آنها را ارائه می دهد.
این دستور علاوه بر ارائه محتوای کمکی در مورد دستورات و پارامتر ها، برای بازیابی محتوای کمکی اسکریپت های خارجی هم قابل استفاده است و برای این کار کافیست مسیر اسکریپت را به عنوان آرگومان دستور Get-Help مشخص کنید.
اگر می خواهید با خیال راحت از این دستورات در سرور خود استفاده کنید و تجربه لذت بخشی از قابلیت های پاورشل داشته باشید می توانید با خرید سرور مجازی ویندوز (Windows VPS) صاحب یک سیستم قوی برای اجرای موثر دستورات و المان های مختلف پاورشل شوید.
سینتکس دستور Get-Help
برای استفاده از این دستور کافیست Get-Help را تایپ کنید و بعد اسم دستور یا المان موردنیاز خود را وارد کنید. مثلاً اگر قصد دارید محتوای کمکی مربوط به کامندلت Get-Process را ببینید، باید دستور Get-Help را به صورت زیر اجرا کنید:
Get-Help Get-Process
اکنون که با سینتکس پایه دستور Get-Help هم آشنا شدیم، بهتر است با یک سری مثال عملی، با پارامترها و کاربردهای این دستور آشنا شویم:
کاربردهای اصلی دستور Get-Help
۱. بازیابی محتوای کمکی Cmdlet
یکی از کاربردهای اصلی دستور Get-Help، بازیابی محتوای کمکی مربوط به Cmdlet ها است. به این صورت که اگر اسم دستور را به عنوان پارامتر دستور وارد کنید، به اطلاعات دقیقی در مورد هدف، سینتکس، پارامترها و مثال های آن دستور دسترسی پیدا می کنید تا به کمک آنها بتوانید استفاده درستی از قابلیت های دستور موردنظر داشته باشید.
به عنوان مثال اگر می خواهید تمام فرآیند های مربوط به سیستم محلی یا ریموت را ببینید، می توانید از کامندلت Get-process استفاده کنید که اطلاعات کمکی خود این cmdlet هم با دستور زیر قابل دسترس است:
Get-Help Get-process
اگر می خواهید پارامتر خاصی را برای دستور در نظر بگیرید و اطلاعات مربوط به آن را ببینید، باید از Parameter کمک بگیرید:
Get-Help Get-Command -Parameter ArgumentList
۲. مشاهده مثال های عملی
دستور Get-Help علاوه بر اینکه توضیحات مفصلی را در مورد المان موردنظر ارائه می دهد، می تواند مثال های عملی را هم در اختیار شما قرار دهد. با استفاده از این مثال ها راحت تر می توانید نحوه استفاده از cmdlet موردنظر در سناریوهای مختلف را یاد بگیرید. در واقع، به کمک این مثال ها می توانید درک بهتری از هدف دستور موردنظر و سازگاری آن با نیازهای خود داشته باشید.
مثلاً برای دیدن مثال های مربوط به دستور Get-process باید آپشن Examples را هم به دستور Get-Help اضافه کنید:
Get-help Get-Service -Examples
۳. دسترسی به جزئیات بیشتر در مورد دستور موردنظر
گاهی اوقات، اطلاعات پایه برایمان کافی نیست و نیاز به جزئیات بیشتر و دقیق تری در مورد اجزا و دستورات پاورشل داریم. اینجاست که آپشن Detailed وارد عمل می شود. با اضافه کردن این آپشن به دستور Get-Help می توانید در دنیای پاورشل ماهرتر شوید و رازهای پنهان آن را هم کشف کنید.
Get-help Get-Service -Detailed
البته اگر می خواهید همراه این اطلاعات دقیق، مثال های عملی را هم ببینید یعنی به نحوی Examples و Detailed را با هم ترکیب کنید، می توانید از آپشن Full استفاده کنید:
Get-help Get-Service -Full
۴. مشاهده راهنمای آنلاین
با دستور Get-Help می توانید به منابع کمکی آنلاین هم دسترسی پیدا کنید. کافیست آپشن Online را به دستور اضافه کنید و سپس تمام داکیومنتیشن آنلاین مربوط به دستور موردنظر را در مرورگر پیش فرض خود ببینید.
به کمک این ویژگی پاورشل می توانید تمام منابع رسمی مایکروسافت و همچنین منابعی که مربوط به مشارکت کاربران یا جامعه پاورشل هستند را هم کشف کنید و از دامنه فایل های کمکی موجود در سیستم خود فراتر بروید:
Get-help Get-Service -Online
۵. جستجوی عنوان های کمکی
پاورشل دارای کامندلت ها، ماژول ها و توابع کمکی متنوعی است و پیدا کردن عنوان مناسب از بین این همه دستور می تواند کمی سخت و طاقت فرسا باشد. خوشبختانه دستور Get-Help برای جستجوی قدرتمندتر هم برنامه ریزی شده است و با استفاده از کلمات کلیدی و حروف عام می توانید دامنه جستجوی خود را محدود کنید و المان موردنظر خود را سریع تر پیدا کنید.
برای این کار کافیست کلمه کلید موردنظر را بعد از دستور Get-Help وارد کنید. مثلاْ برای جستجوی دستورات حاوی کلمه process باید دستور زیر را اجرا کنید:
Get-Help process
حالا اگر بخواهید حروف عام را هم وارد صحنه کنید و به عنوان مثال دنبال دستوراتی باشید که با process- خاتمه پیدا می کنند، دستور Get-Help را به صورت زیر اجرا کنید:
Get-Help *-process
بعضی از موضوعات کمکی هم هستند که با About شروع می شوند و برای درک نحوه دستورات و توابع پاورشل انتخاب خوبی هستند. اگر می خواهید به همه این موضوعات دسترسی پیدا کنید می توانید از دستور زیر استفاده کنید:
Get-Help About_*
۶. فیلتر و قالب بندی اطلاعات خروجی
دستور Get-Help به ترجیحات شما هم اهمیت می دهد و گزینه هایی را برای فیلتر و فرمت خروجی لحاظ کرده است. به این صورت که با استفاده از پارامترهایی مثل Category ،Role و Functionality می توانید اطلاعات خروجی را اصلاح کنید. همچنین برای بهبود خوانایی و تمرکز بیشتر روی جزئیات مربوطه می توانید خروجی را به صورت لیست، جدول یا نمای دقیق تر قالب بندی کنید.
Category یکی از پارامترهای لازم برای فیلتر کردن دسته های خروجی است و می تواند با Alias ،Cmdlet Provider ،General ،scriptCommand و … مقدار دهی شود. به عنوان مثال:
Get-Help -Category Alias
۷. سفارشی سازی خروجی
اگر می خواهید ظاهر و محتوای خروجی دستور Get-Help را تغییر دهید و آن را به شکل دلخواه خود دربیاورید می توانید فایل “help.format.ps1xml” را تغییر دهید. اگر خروجی را مطابق با سبک خود شخصی سازی کنید مطمئنا تجربه ای که از کار کردن با این دستور خواهید داشت خیلی دلچسب تر خواهد شد.
۸. استفاده از Get-Help برای ماژول ها
ماژول های پاورشل واحد های مستقلی هستند که قابلیت های پوسته را گسترش می دهند. Get-Help برای کسب اطلاعات بیشتر در مورد ماژول ها هم استفاده می شود. پس اگر در زمینه ماژول ها نیاز به راهنمایی دارید و دوست دارید عملکرد، دستورات و نمونه هایی از آنها را ببینید می توانید از دستور Get-Help کمک بگیرید.
Get-Help -Name <ModuleName>
۹. استفاده از Get-Help برای ارائه دهندگان
ارائه دهندگان پاورشل برنامه های دان نت هستند که دسترسی به data store های خاص و مدیریت آنها را آسان تر می کنند. وقتی از دستور Get-Help برای ارائه دهنده خاصی استفاده می کنید، در واقع به data store که در فایل سیستم نیسا دسترسی پیدا می کنید و اطلاعات cmdlet های مرتبط با آن را می بینید. به عنوان مثال برای مشاهده دستورات مربوط به registery باید از دستور زیر استفاده کنید:
Get-Help registry
۱۰. دسترسی به اطلاعات کمکی برای Alias ها
Alias ها میانبرهای یا نام های جایگزین (مستعار) برای دستورات پاورشل هستند. دستور Get-Help برای این نوع متغیرها هم قابل استفاده هستند و کافیست یک اسم مستعار را برای پارامتر موردنظر تعیین کنید و بعد با اجرای دستور Get-Help تمام اطلاعات مربوطه cmdlet های آن و نحوه استفاده از آنها را در خروجی ببینید.
مثلا اگر می خواهید اسم مستعار gas را برای دستور Get-AuthenticodeSignature تعیین کنید، باید ابتدا دستور زیر را اجرا کنید:
New-Alias -Name gas -Value Get-AuthenticodeSignature
بعد دستور get-help را به صورت زیر اجرا کنید:
get-help gas
۱۱. دستیابی به اطلاعات متغیرها
متغیرها نقش مهمی در اسکریپت نویسی پاورشل دارند و با استفاده از آنها می توانید داده ها را ذخیره و دستکاری کنید. Get-Help این امکان را به شما می دهد که راهنمایی های مرتبط با متغیرها را ببینید و با نحوه کار و ویژگی ها آنها آشنا شوید. این اطلاعات برای استفاده موثر از متغیرها مفید هستند.
مثلا برای دستیابی به اطلاعات کمکی در مورد متغیر PSVersionTable باید دستور Get-Help را به صورت زیر اجرا کنید:
Get-Help PSVersionTable
تکنیک های راهنمایی پیشرفته
دستور Get-Help تکنیک های پیشرفته دیگری را هم ارائه می دهد تا کاربران فرصت یادگیری بیشتری داشته باشند. به عنوان مثال، پارامتر ShowWindow برای باز کردن محتوای کمکی در یک پنجره جدا لحاظ شده است تا کاربر مطالب را با تمرکز و دقت بیشتری دنبال کند.
Get-Help Get-Process -ShowWindow
همچنین می توانید موضوعات راهنمایی که با “about_” شروع می شوند را هم فیلتر کنید تا به اطلاعات عمیق تری در مورد مفاهیم اصلی و ویژگی های پیشرفته پاورشل دسترسی پیدا کنید.
کلام آخر
دستور Get-Help یکی از ابزارهای ارزشمند کاربران PowerShell است و این امکان را به شما می دهد که به داکیومنتیشن، راهنمایی ها و مثال های کاربردی در مورد المان های مختلف پاورشل دسترسی داشته باشید. اگر نحوه استفاده از Get-Help را یاد بگیرید، به مرور زمان نحوه استفاده از دستورات و سایر المان های پاورشل را هم یاد خواهید گرفت و زمینه لازم برای لذت بردن از قابلیت های پاورشل فراهم می شود.
از اینکه تا انتهای مقاله با ما همراه بودید، از شما متشکریم. امیدواریم که مطالعه این مقاله برای شما مفید واقع شده باشد. در صورت داشتن هرگونه سوال، درخواست و نیاز به راهنمایی، می توانید با ثبت نظر خود، با ما وارد ارتباط شوید تا هر چه زودتر به شما پاسخ دهیم.
سوالات متداول:
آیا Get-Help برای همه cmdlet های PowerShell در دسترس است؟
بله صد در صد. این دستور برای تمام تمام cmdlet های داخلی و سفارشی پاورشل در دسترس است.
آیا دستور Get-Help برای کشف اطلاعات کمکی توابع هم قابل استفاده است؟
بله با این دستور می توانید به اطلاعات مربوط به توابع داخلی و تعریف شده توسط کاربر دسترسی پیدا کنید.
آیا می توانم در داکیومنتیشن Get-Help مشارکت کنم؟
بله شما می توانید به انجمن بپیوندید و در پروسه بهبود داکیومنتیشن Get-Help مشارکت داشته باشید.
آیا می توان محتوای Get-Help را به صورت آفلاین آپدیت کرد؟
بله. با استفاده از دستور cmdlet Update-Help می توانید آخرین محتوای این دستور را آپدیت و دانلود کنید.