PowerShellギャラリーは、Microsoftが提供するPowerShellモジュールの共有プラットフォームです。
開発者は、ここで独自のモジュールを公開し、他のユーザーが簡単にインストール・利用できるようになります。Install-Module コマンドで、公開されたモジュールを誰でもダウンロード・使用可能です。
PowerShellギャラリーへの公開は、自作ツールを広めたり、自分のスクリプトを他の人と共有する良い機会です。
PowerShellにおけるモジュールとは
PowerShellでは、複数のコマンドレット（関数）やスクリプトを1つのまとまりとして管理するために「モジュール」を使用します。
モジュールは、1つ以上の関数やスクリプトファイル（.ps1）を集めたものであり、.psm1形式のファイルとして定義します。
このモジュール化を行うことで、スクリプトの再利用性を高め、他のプロジェクトやスクリプトから簡単に呼び出して利用できるようになります。
モジュールの公開に必要な準備
モジュールを公開するためには、以下の準備が必要です。
- PowerShell 5.1 以上のインストール
- NuGet プロバイダーのインストール
- Microsoft アカウント（PowerShellギャラリー用）
- APIキーの取得（後述）
- モジュールの作成（PS1ファイルや、
psd1とpsm1の設定が必要）
PowerShellモジュールの作成手順
(1) モジュールの構造
モジュールは次のようなファイル構成が基本です。
MyModule/
│-- MyModule.psd1 # モジュールマニフェスト
│-- MyModule.psm1 # 関数やロジックの本体
└-- functions/ # 個別の関数を格納するフォルダ(2) 必要なファイルの作成
- モジュールマニフェスト (MyModule.psd1)
以下のコマンドで自動生成できます。
New-ModuleManifest -Path ".\MyModule\MyModule.psd1" `
-RootModule "MyModule.psm1" `
-Author "YourName" `
-Description "This is a sample PowerShell module."- 関数定義 (MyModule.psm1)
関数を定義するためにpsm1ファイルに以下のようなコードを書きます。
function Get-HelloWorld {
[CmdletBinding()]
param(
[string]$Name = "World"
)
Write-Output "Hello, $Name!"
}PowerShellギャラリーへのアカウント登録とAPIキーの取得
- MicrosoftアカウントでPowerShellギャラリーにログイン
- PowerShellギャラリーにアクセスし、右上の「サインイン」をクリックします。
- APIキーの取得
- ログイン後、右上の「Manage Account」から「API Keys」をクリックします。
- 「Generate New Key」を押して新しいAPIキーを取得します。
モジュールをPowerShellギャラリーに公開する手順
(1) APIキーをPowerShellに設定
$ApiKey = "取得したAPIキーをここに貼り付けます"(2) NuGetプロバイダーをインストール
Install-PackageProvider -Name NuGet -Force(3) モジュールを公開
以下のコマンドでモジュールをPowerShellギャラリーに公開します。
Publish-Module -Path ".\MyModule" -NuGetApiKey $ApiKey公開に失敗した場合の対処法
- APIキーの有効期限切れ
- APIキーの期限が切れていないか確認し、必要に応じて新しいキーを生成します。
- 依存モジュールの指定ミス
- psd1ファイル内のRequiredModulesセクションが正しいか確認します。
- NuGetプロバイダーが古い
- 以下のコマンドでNuGetプロバイダーを再インストールします。
Install-PackageProvider -Name NuGet -Force -Scope CurrentUserなぜモジュール化が必要なのか
再利用性とメンテナンスの向上
モジュール化は、スクリプトの再利用性を高め、同じコードを複数の場所で再利用できるようにするための手法です。
例えば、ユーザー管理のスクリプトが複数のプロジェクトで必要な場合、すべてのプロジェクトでそのスクリプトを作成するのは非効率的です。
モジュール化することで、一つのコードを修正するだけで、他のプロジェクトにも自動的に反映されます。
チーム開発における利便性
複数のメンバーでプロジェクトを進める場合、スクリプトが細分化され、個別のファイルやモジュールに分割されていると、担当者ごとにコードの分担が可能になり、作業効率が向上します。
モジュール化されたスクリプトは、他のメンバーが簡単に呼び出して利用できるようになります。
演習問題と解答例
演習問題
- 次のようなGet-RandomGreetingという関数を含むモジュールを作成してください。関数は、複数の挨拶からランダムに1つを返します。
- 上記のモジュールを作成したら、PowerShellギャラリーに公開してください。
- 公開したモジュールを、Install-Moduleを使って他のPCにインストールする手順を試してください。
サンプルコード（Get-RandomGreeting）
function Get-RandomGreeting {
[CmdletBinding()]
param(
[string[]]$Greetings = @("Hello", "Hi", "Welcome", "Greetings")
)
$Index = Get-Random -Minimum 0 -Maximum $Greetings.Length
Write-Output $Greetings[$Index]
}解答例
- モジュールの構造
RandomGreetingModule/
│-- RandomGreetingModule.psd1
│-- RandomGreetingModule.psm1- psm1ファイルの中身
function Get-RandomGreeting {
[CmdletBinding()]
param(
[string[]]$Greetings = @("Hello", "Hi", "Welcome", "Greetings")
)
$Index = Get-Random -Minimum 0 -Maximum $Greetings.Length
Write-Output $Greetings[$Index]
}- モジュールの公開
Publish-Module -Path ".\RandomGreetingModule" -NuGetApiKey $ApiKey- 公開モジュールのインストール
Install-Module -Name RandomGreetingModule -Scope CurrentUserまとめ
PowerShellギャラリーにモジュールを公開することで、自作の便利なスクリプトを他のユーザーと共有できます。
本記事で紹介した手順に従えば、初心者でも簡単にモジュールを作成し、公開することが可能です。
公開後はフィードバックを受けて改善を重ね、より多くのユーザーに使ってもらえるようにしましょう。
この記事を通して、PowerShellモジュールの作成から公開までの一連の流れが理解できたはずです。
次はぜひ自分のオリジナルモジュールを作って、公開してみましょう！