ja-JP/QiitaDrive.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" schema="maml" xmlns="http://msh"> <command:command> <command:details> <command:name>Clear-QiitaCache</command:name> <maml:description> <maml:para>Qiita ドライブのキャッシュをクリアします。</maml:para> </maml:description> <command:verb>Clear</command:verb> <command:noun>QiitaCache</command:noun> </command:details> <maml:description> <maml:para>QiitaDrive が保持するインメモリキャッシュをクリアします。 パスを指定すると、そのフォルダのキャッシュのみをクリアします。 省略するとすべてのキャッシュがクリアされます。</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Clear-QiitaCache</maml:name> <command:parameter required="false" variableLength="false" globbing="true" pipelineInput="false" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>クリア対象のパス。Items, Tags, Tags/{name}, Users, Users/{name}, Search, Search/{query}, Me が指定可能です。 複数のパスをカンマ区切りで指定できます。ワイルドカード (* や ?) でフォルダ名を絞り込むこともできます。 省略するとすべてのキャッシュをクリアします。</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.String[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Clear-QiitaCache</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>LiteralPath</maml:name> <maml:description> <maml:para>クリア対象のリテラルパス。ワイルドカード文字 (* や ?) をエスケープせずそのまま使用します。 タグ名に `*` や `?` を含むパス (例: `Tags/C*`) を正確に指定する場合に使用します。 PSPath プロパティからのパイプライン入力に対応しています。</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>LiteralPath</maml:name> <maml:description> <maml:para>クリア対象のリテラルパス。ワイルドカード文字 (* や ?) をエスケープせずそのまま使用します。 タグ名に `*` や `?` を含むパス (例: `Tags/C*`) を正確に指定する場合に使用します。 PSPath プロパティからのパイプライン入力に対応しています。</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="true" pipelineInput="false" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>クリア対象のパス。Items, Tags, Tags/{name}, Users, Users/{name}, Search, Search/{query}, Me が指定可能です。 複数のパスをカンマ区切りで指定できます。ワイルドカード (* や ?) でフォルダ名を絞り込むこともできます。 省略するとすべてのキャッシュをクリアします。</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>進行状況バーの動作を制御します。</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">ActionPreference</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <dev:name>None</dev:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> <command:inputType> <dev:type> <dev:name>System.String</dev:name> </dev:type> <maml:description> <maml:para>-Path または -LiteralPath パラメータへの文字列配列入力。</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <dev:name>None</dev:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>dir -Force でもフォルダ単位のキャッシュがクリアされます。</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1: すべてのキャッシュをクリア ---------</maml:title> <maml:introduction> <maml:para>```powershell PS C:\> Clear-QiitaCache ```</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 2: 特定タグのキャッシュをクリア ---------</maml:title> <maml:introduction> <maml:para>```powershell PS C:\> Clear-QiitaCache -Path Tags/PowerShell ```</maml:para> <maml:para>PowerShell タグの記事リストキャッシュのみクリアします。次回 dir 時に API から再取得されます。</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 3: 自分の記事キャッシュをクリア ---------</maml:title> <maml:introduction> <maml:para>```powershell PS C:\> Clear-QiitaCache -Path Me ```</maml:para> <maml:para>Me 配下のキャッシュ (投稿記事、ストック、フォロー中タグ) をクリアします。</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 4: ワイルドカードで複数タグのキャッシュをクリア ---------</maml:title> <maml:introduction> <maml:para>```powershell PS C:\> Clear-QiitaCache -Path Tags/Power* ```</maml:para> <maml:para>PowerShell、PowerBI など "Power" で始まるタグのキャッシュをクリアします。</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 5: リテラルパスでクリア (ワイルドカード無効) ---------</maml:title> <maml:introduction> <maml:para>```powershell PS C:\> Clear-QiitaCache -LiteralPath Tags/C* ```</maml:para> <maml:para>タグ名 "C*" のキャッシュをワイルドカード展開せず、そのままクリアします。</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 6: 複数パスのキャッシュをクリア ---------</maml:title> <maml:introduction> <maml:para>```powershell PS C:\> Clear-QiitaCache -Path Tags/PowerShell, Tags/CSharp ```</maml:para> <maml:para>PowerShell タグと CSharp タグのキャッシュをクリアします。</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>New-QiitaDrive</maml:linkText> <command:uri /> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-QiitaItem</command:name> <maml:description> <maml:para>Qiita の記事を URL または ID で取得します。</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>QiitaItem</command:noun> </command:details> <maml:description> <maml:para>URL、フル ID、または短縮 ID を指定して Qiita の記事を取得します。 結果は Qiita API の記事オブジェクト (QiitaItem) で、Body プロパティに本文が含まれます。 User や Tags などのネストしたプロパティもそのまま利用できます。</maml:para> <maml:para>URL のドメインから対応するドライブを自動判別します。 ID のみの場合は、current location のドライブまたは `-Path` で指定したドライブを使用します。</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-QiitaItem</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>記事の URL、フル ID (20文字)、または短縮 ID。 URL 形式: `https://qiita.com/{user}/items/{id}` または `https://{team}.qiita.com/{user}/items/{id}`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>対象ドライブを指定するパス (例: `MyTeam:\`)。URL 入力時はドメインから自動判別されるため、通常は不要です。 省略時は current location のドライブを使用します。</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>記事の URL、フル ID (20文字)、または短縮 ID。 URL 形式: `https://qiita.com/{user}/items/{id}` または `https://{team}.qiita.com/{user}/items/{id}`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>対象ドライブを指定するパス (例: `MyTeam:\`)。URL 入力時はドメインから自動判別されるため、通常は不要です。 省略時は current location のドライブを使用します。</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>進行状況バーの動作を制御します。</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">ActionPreference</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <dev:name>System.String</dev:name> </dev:type> <maml:description> <maml:para>記事の URL または ID をパイプラインから受け取ります。</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <dev:name>QiitaDrive.Models.QiitaItem</dev:name> </dev:type> <maml:description> <maml:para>Qiita API の記事オブジェクト。Body, User, Tags などすべてのプロパティを含みます。</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>- Get-QiitaItem で取得した場合、Body には記事の Markdown 本文が含まれます。 - 短縮 ID はキャッシュ内でのみ有効です。キャッシュにない場合はフル ID として API に問い合わせます。 - URL のドメインから対応するドライブを自動判別します。</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1: URL で記事を取得 ---------</maml:title> <maml:introduction> <maml:para>```powershell PS C:\> Get-QiitaItem https://qiita.com/ytsuda/items/1c6bf5d89a0b4e... ```</maml:para> <maml:para>Qiita の記事 URL から直接記事を取得します。</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 2: フル ID で取得 ---------</maml:title> <maml:introduction> <maml:para>```powershell PS C:\> Get-QiitaItem 1c6bf5d89a0b4e1a2b3c ```</maml:para> <maml:para>20 文字のフル ID で記事を API から取得します。</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 3: 短縮 ID で取得 (キャッシュ内) ---------</maml:title> <maml:introduction> <maml:para>```powershell PS C:\> dir Qiita:\Tags\PowerShell PS C:\> Get-QiitaItem 1c6bf5d ```</maml:para> <maml:para>事前に dir でキャッシュに読み込んだ記事を短縮 ID で取得できます。 キャッシュにない場合はフル ID として API に問い合わせます。</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 4: 本文を含めて表示 ---------</maml:title> <maml:introduction> <maml:para>```powershell PS C:\> Get-QiitaItem https://qiita.com/ytsuda/items/abc123 | Select-Object Title, Body ```</maml:para> <maml:para>Body プロパティに記事の Markdown 本文が含まれます。</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 5: パイプラインで複数取得 ---------</maml:title> <maml:introduction> <maml:para>```powershell PS C:\> "id1", "id2" | Get-QiitaItem ```</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 6: 記事をブラウザで開く ---------</maml:title> <maml:introduction> <maml:para>```powershell PS C:\> Get-QiitaItem https://qiita.com/ytsuda/items/abc123 | Open-QiitaPage ```</maml:para> <maml:para>Path プロパティにより Open-QiitaPage にパイプできます。</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Resolve-QiitaPath</maml:linkText> <command:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-QiitaDrive</maml:linkText> <command:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Open-QiitaPage</maml:linkText> <command:uri /> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>New-QiitaDrive</command:name> <maml:description> <maml:para>Qiita API に接続する PSDrive をマウントします。</maml:para> </maml:description> <command:verb>New</command:verb> <command:noun>QiitaDrive</command:noun> </command:details> <maml:description> <maml:para>Qiita API v2 に接続し、記事をファイルシステムとして閲覧できる PSDrive を作成します。 認証はブラウザでの OAuth 認証か、-Token パラメータによるアクセストークン指定のいずれかで行います。 OAuth を使用する場合、ブラウザが自動的に開き、認証完了後にドライブがマウントされます。</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-QiitaDrive</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>BaseUri</maml:name> <maml:description> <maml:para>Qiita API のベース URI。通常は変更不要です。-BaseUri を指定する場合は -Name も必須です。</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ClientId</maml:name> <maml:description> <maml:para>OAuth クライアント ID。カスタム OAuth アプリケーションを使用する場合に指定します。</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ClientSecret</maml:name> <maml:description> <maml:para>OAuth クライアントシークレット。-ClientId と組み合わせて使用します。</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>ドライブ名。省略時は "Qiita" が使用されます。</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Team</maml:name> <maml:description> <maml:para>Qiita Team 名。指定すると https://{Team}.qiita.com に接続します。</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Token</maml:name> <maml:description> <maml:para>Qiita API アクセストークン。省略時はブラウザで OAuth 認証が行われます。</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>BaseUri</maml:name> <maml:description> <maml:para>Qiita API のベース URI。通常は変更不要です。-BaseUri を指定する場合は -Name も必須です。</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ClientId</maml:name> <maml:description> <maml:para>OAuth クライアント ID。カスタム OAuth アプリケーションを使用する場合に指定します。</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ClientSecret</maml:name> <maml:description> <maml:para>OAuth クライアントシークレット。-ClientId と組み合わせて使用します。</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>ドライブ名。省略時は "Qiita" が使用されます。</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>進行状況バーの動作を制御します。</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Team</maml:name> <maml:description> <maml:para>Qiita Team 名。指定すると https://{Team}.qiita.com に接続します。</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Token</maml:name> <maml:description> <maml:para>Qiita API アクセストークン。省略時はブラウザで OAuth 認証が行われます。</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.String</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <dev:name>None</dev:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <dev:name>None</dev:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>同名のドライブが既に存在する場合、自動的に既存ドライブを破棄して再マウントします。</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1: OAuth 認証でマウント ---------</maml:title> <maml:introduction> <maml:para>```powershell PS C:\> New-QiitaDrive ```</maml:para> <maml:para>ブラウザが開き、Qiita OAuth 認証が行われます。認証成功後、Qiita:\ ドライブがマウントされます。</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 2: トークン指定でマウント ---------</maml:title> <maml:introduction> <maml:para>```powershell PS C:\> New-QiitaDrive -Token $env:QIITA_TOKEN ```</maml:para> <maml:para>環境変数に保存されたアクセストークンを使用して Qiita:\ ドライブをマウントします。</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 3: Qiita Team に接続 ---------</maml:title> <maml:introduction> <maml:para>```powershell PS C:\> New-QiitaDrive -Name MyTeam -Team myteamname ```</maml:para> <maml:para>Qiita Team 環境に MyTeam:\ としてマウントします。</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 4: カスタム BaseUri で接続 ---------</maml:title> <maml:introduction> <maml:para>```powershell PS C:\> New-QiitaDrive -Name Dev -BaseUri https://staging.qiita.com -Token $token ```</maml:para> <maml:para>本番以外の環境に Dev:\ として接続します。-BaseUri 使用時は -Name の指定が必須です。</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Clear-QiitaCache</maml:linkText> <command:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Open-QiitaPage</maml:linkText> <command:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Copy-QiitaItem</maml:linkText> <command:uri /> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Open-QiitaPage</command:name> <maml:description> <maml:para>対応する Qiita Web ページをブラウザで開きます。</maml:para> </maml:description> <command:verb>Open</command:verb> <command:noun>QiitaPage</command:noun> </command:details> <maml:description> <maml:para>Qiita ドライブ上のパスに対応する Qiita Web ページを既定のブラウザで開きます。 記事ファイルの場合は記事ページ、フォルダの場合は対応する一覧ページが開きます。</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Open-QiitaPage</maml:name> <command:parameter required="true" variableLength="false" globbing="true" pipelineInput="false" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Qiita ドライブ上のパス。記事ファイルまたはフォルダのパスを指定します。 複数のパスをカンマ区切りで指定できます。ワイルドカード (* や ?) でファイル名を絞り込むこともできます。</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.String[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Open-QiitaPage</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>LiteralPath</maml:name> <maml:description> <maml:para>Qiita ドライブ上のリテラルパス。ワイルドカード文字 (* や ?) をエスケープせずそのまま使用します。 タグ名に `*` や `?` を含むパス (例: `Tags/C*`) を正確に指定する場合に使用します。 PSPath プロパティからのパイプライン入力に対応しています。</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>LiteralPath</maml:name> <maml:description> <maml:para>Qiita ドライブ上のリテラルパス。ワイルドカード文字 (* や ?) をエスケープせずそのまま使用します。 タグ名に `*` や `?` を含むパス (例: `Tags/C*`) を正確に指定する場合に使用します。 PSPath プロパティからのパイプライン入力に対応しています。</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="true" pipelineInput="false" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Qiita ドライブ上のパス。記事ファイルまたはフォルダのパスを指定します。 複数のパスをカンマ区切りで指定できます。ワイルドカード (* や ?) でファイル名を絞り込むこともできます。</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>進行状況バーの動作を制御します。</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">ActionPreference</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <dev:name>System.String</dev:name> </dev:type> <maml:description> <maml:para>PSPath プロパティによるパイプライン入力を受け付けます (LiteralPath パラメータセット)。</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <dev:name>System.String</dev:name> </dev:type> <maml:description> <maml:para>-Path または -LiteralPath パラメータへの文字列配列入力。</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <dev:name>None</dev:name> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Invoke-Item (ii) でも記事ファイルは一時 .md として開き、フォルダは Web ページを開きます。</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1: 記事をブラウザで開く ---------</maml:title> <maml:introduction> <maml:para>```powershell PS Qiita:\Tags\PowerShell> Open-QiitaPage .\abc1234_Title.md ```</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 2: タグページを開く ---------</maml:title> <maml:introduction> <maml:para>```powershell PS C:\> Open-QiitaPage Qiita:\Tags\PowerShell ```</maml:para> <maml:para>Qiita の PowerShell タグページをブラウザで開きます。</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 3: パイプラインから渡す ---------</maml:title> <maml:introduction> <maml:para>```powershell PS Qiita:\Me\Items> dir | Select-Object -First 1 | Open-QiitaPage ```</maml:para> <maml:para>最初の記事の Qiita ページを開きます。</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 4: ワイルドカードで複数記事を開く ---------</maml:title> <maml:introduction> <maml:para>```powershell PS Qiita:\Me\Items> Open-QiitaPage *PowerShell* ```</maml:para> <maml:para>タイトルに "PowerShell" を含む記事をすべてブラウザで開きます。</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 5: リテラルパスで開く (ワイルドカード無効) ---------</maml:title> <maml:introduction> <maml:para>```powershell PS C:\> Open-QiitaPage -LiteralPath Qiita:\Tags\C* ```</maml:para> <maml:para>タグ名 "C*" のページをワイルドカード展開せず、そのままブラウザで開きます。</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 6: 複数パスを指定して開く ---------</maml:title> <maml:introduction> <maml:para>```powershell PS C:\> Open-QiitaPage Qiita:\Tags\PowerShell, Qiita:\Tags\CSharp ```</maml:para> <maml:para>PowerShell タグページと CSharp タグページをブラウザで開きます。</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>New-QiitaDrive</maml:linkText> <command:uri /> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Resolve-QiitaPath</command:name> <maml:description> <maml:para>Qiita の URL または記事 ID をプロバイダパスに変換します。</maml:para> </maml:description> <command:verb>Resolve</command:verb> <command:noun>QiitaPath</command:noun> </command:details> <maml:description> <maml:para>Qiita の記事 URL、フル ID、または短縮 ID をプロバイダパス(例: `Qiita:\CachedItems\abc1234_Title.md`)に 変換します。記事がキャッシュにない場合は API から取得してキャッシュに追加します。</maml:para> <maml:para>URL に含まれるドメインから対応するドライブを自動判別します。 Qiita Team の URL の場合、BaseUri が一致するドライブが選択されます。</maml:para> <maml:para>結果は文字列なので、Get-Content, Get-Item, Open-QiitaPage などにそのままパイプできます。</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Resolve-QiitaPath</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>記事の URL、フル ID (20文字)、または短縮 ID。 URL 形式: `https://qiita.com/{user}/items/{id}` または `https://{team}.qiita.com/{user}/items/{id}`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>対象ドライブを指定するパス (例: `MyTeam:\`)。URL 入力時はドメインから自動判別されるため、通常は不要です。 省略時は current location のドライブを使用します。</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>記事の URL、フル ID (20文字)、または短縮 ID。 URL 形式: `https://qiita.com/{user}/items/{id}` または `https://{team}.qiita.com/{user}/items/{id}`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>対象ドライブを指定するパス (例: `MyTeam:\`)。URL 入力時はドメインから自動判別されるため、通常は不要です。 省略時は current location のドライブを使用します。</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>進行状況バーの動作を制御します。</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">ActionPreference</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <dev:name>System.String</dev:name> </dev:type> <maml:description> <maml:para>記事の URL または ID をパイプラインから受け取ります。</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <dev:name>System.String</dev:name> </dev:type> <maml:description> <maml:para>プロバイダパス(例: `Qiita:\CachedItems\abc1234_Title.md`)。</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>- URL のドメインから対応するドライブを自動判別します。 - 短縮 ID はキャッシュ内でのみ有効です。キャッシュにない場合はフル ID として API に問い合わせます。</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1: URL をプロバイダパスに変換 ---------</maml:title> <maml:introduction> <maml:para>```powershell PS C:\> Resolve-QiitaPath https://qiita.com/ytsuda/items/1c6bf5d89a0b4e... Qiita:\CachedItems\1c6bf5d_いま一番新しい、Git の使い方を学ぶ方法.md ```</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 2: 記事の本文を取得 ---------</maml:title> <maml:introduction> <maml:para>```powershell PS C:\> Resolve-QiitaPath https://qiita.com/ytsuda/items/abc123... | Get-Content ```</maml:para> <maml:para>パスを Get-Content にパイプして記事の本文を取得します。</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 3: 記事をブラウザで開く ---------</maml:title> <maml:introduction> <maml:para>```powershell PS C:\> Resolve-QiitaPath https://qiita.com/ytsuda/items/abc123... | Open-QiitaPage ```</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 4: 短縮 ID から解決 ---------</maml:title> <maml:introduction> <maml:para>```powershell PS C:\> dir Qiita:\Tags\PowerShell PS C:\> Resolve-QiitaPath 1c6bf5d Qiita:\CachedItems\1c6bf5d_いま一番新しい、Git の使い方を学ぶ方法.md ```</maml:para> <maml:para>事前に dir でキャッシュに読み込んだ記事を短縮 ID で解決できます。</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-QiitaItem</maml:linkText> <command:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-QiitaDrive</maml:linkText> <command:uri /> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Search-QiitaContent</command:name> <maml:description> <maml:para>キャッシュ済み Qiita 記事の本文を正規表現で全文検索します。</maml:para> </maml:description> <command:verb>Search</command:verb> <command:noun>QiitaContent</command:noun> </command:details> <maml:description> <maml:para>キャッシュ済みの Qiita 記事本文を正規表現パターンで検索し、マッチした行を表示します。 結果は記事パスごとにグループ化されたテーブルビューで出力されます。 マッチしたキーワードは黄色でハイライト表示されます。</maml:para> <maml:para>検索対象は `dir` 等で事前に本文を取得済み (キャッシュ済み) の記事のみです。 `-Path` で検索範囲をフォルダ単位で絞り込めます。ワイルドカードによるファイル名フィルタも可能です。</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Search-QiitaContent</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Context</maml:name> <maml:description> <maml:para>マッチ行の前後に表示するコンテキスト行数 (0〜10)。既定値は 0 です。</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="true" pipelineInput="false" position="1" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>検索対象のパス。フォルダを指定するとそのフォルダ内の記事を検索します。 複数のパスをカンマ区切りで指定できます。 ワイルドカード (* や ?) でファイル名を絞り込むこともできます。 省略時は current location またはドライブルートの CachedItems が対象になります。</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Pattern</maml:name> <maml:description> <maml:para>検索する正規表現パターン。大文字・小文字は区別しません。</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>Tags、Users、Search、Me などのコンテナフォルダを再帰的に検索します。 ルートで指定すると全フォルダを検索します。 重複する記事は最初に見つかったフォルダでのみ結果を表示します。</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.Management.Automation.SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Search-QiitaContent</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Context</maml:name> <maml:description> <maml:para>マッチ行の前後に表示するコンテキスト行数 (0〜10)。既定値は 0 です。</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>LiteralPath</maml:name> <maml:description> <maml:para>検索対象のリテラルパス。ワイルドカード文字 (* や ?) をエスケープせずそのまま使用します。 タグ名に `*` や `?` を含むパス (例: `Tags/C*`) を正確に指定する場合に使用します。 PSPath プロパティからのパイプライン入力に対応しています。</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Pattern</maml:name> <maml:description> <maml:para>検索する正規表現パターン。大文字・小文字は区別しません。</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>Tags、Users、Search、Me などのコンテナフォルダを再帰的に検索します。 ルートで指定すると全フォルダを検索します。 重複する記事は最初に見つかったフォルダでのみ結果を表示します。</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.Management.Automation.SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Context</maml:name> <maml:description> <maml:para>マッチ行の前後に表示するコンテキスト行数 (0〜10)。既定値は 0 です。</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>LiteralPath</maml:name> <maml:description> <maml:para>検索対象のリテラルパス。ワイルドカード文字 (* や ?) をエスケープせずそのまま使用します。 タグ名に `*` や `?` を含むパス (例: `Tags/C*`) を正確に指定する場合に使用します。 PSPath プロパティからのパイプライン入力に対応しています。</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="true" pipelineInput="false" position="1" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>検索対象のパス。フォルダを指定するとそのフォルダ内の記事を検索します。 複数のパスをカンマ区切りで指定できます。 ワイルドカード (* や ?) でファイル名を絞り込むこともできます。 省略時は current location またはドライブルートの CachedItems が対象になります。</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Pattern</maml:name> <maml:description> <maml:para>検索する正規表現パターン。大文字・小文字は区別しません。</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>Tags、Users、Search、Me などのコンテナフォルダを再帰的に検索します。 ルートで指定すると全フォルダを検索します。 重複する記事は最初に見つかったフォルダでのみ結果を表示します。</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">System.Management.Automation.SwitchParameter</command:parameterValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <dev:name>System.String</dev:name> </dev:type> <maml:description> <maml:para>-Path または -LiteralPath パラメータへの文字列配列入力。</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <dev:name>PSObject (QiitaDrive.SearchResult)</dev:name> </dev:type> <maml:description> <maml:para>Article (記事パス)、Line (行番号)、Body (本文行) プロパティを持つオブジェクト。 Format.ps1xml により記事パスごとにグループ化されたテーブルで表示されます。</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>- 検索対象は `dir` や `Get-QiitaItem` で本文をキャッシュ済みの記事のみです。 - `-Recurse` でルートから検索すると、CachedItems → Me → Search → Tags → Users の順で検索します。 - 複数フォルダに属する記事は、最初に見つかったフォルダでのみ結果を表示し、重複分は警告を出力します。</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1: キャッシュ済み記事を検索 ---------</maml:title> <maml:introduction> <maml:para>```powershell PS Qiita:\> Search-QiitaContent PowerShell ```</maml:para> <maml:para>CachedItems 内の全記事から "PowerShell" を検索します。</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 2: 特定タグの記事を検索 ---------</maml:title> <maml:introduction> <maml:para>```powershell PS C:\> Search-QiitaContent API -Path Qiita:\Tags\PowerShell ```</maml:para> <maml:para>PowerShell タグの記事から "API" を検索します。</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 3: 全フォルダを再帰的に検索 ---------</maml:title> <maml:introduction> <maml:para>```powershell PS Qiita:\> Search-QiitaContent Docker -Recurse ```</maml:para> <maml:para>CachedItems、Me、Search、Tags、Users の全フォルダを検索します。 重複する記事は最初に見つかったフォルダでのみ表示されます。</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 4: コンテキスト行を表示 ---------</maml:title> <maml:introduction> <maml:para>```powershell PS Qiita:\> Search-QiitaContent error -Context 2 ```</maml:para> <maml:para>マッチ行の前後 2 行をコンテキストとして表示します。</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 5: ワイルドカードでファイル名を絞り込み ---------</maml:title> <maml:introduction> <maml:para>```powershell PS C:\> Search-QiitaContent git -Path Qiita:\Me\Items\*PowerShell* ```</maml:para> <maml:para>タイトルに "PowerShell" を含む自分の記事から "git" を検索します。</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 6: 複数パスを指定して検索 ---------</maml:title> <maml:introduction> <maml:para>```powershell PS C:\> Search-QiitaContent Docker -Path Qiita:\Tags\PowerShell, Qiita:\Tags\Azure ```</maml:para> <maml:para>PowerShell タグと Azure タグの記事から "Docker" を検索します。</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 7: リテラルパスで検索 (ワイルドカード無効) ---------</maml:title> <maml:introduction> <maml:para>```powershell PS C:\> Search-QiitaContent pointer -LiteralPath Qiita:\Tags\C* ```</maml:para> <maml:para>タグ名 "C*" のフォルダをワイルドカード展開せず、そのまま検索対象にします。</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> <command:example> <maml:title>--------- Example 8: 正規表現パターン ---------</maml:title> <maml:introduction> <maml:para>```powershell PS Qiita:\> Search-QiitaContent "\b[A-Z]{2,}\b" -Path Tags\CSharp ```</maml:para> <maml:para>CSharp タグの記事から 2 文字以上の大文字英単語を検索します。</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <command:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-QiitaItem</maml:linkText> <command:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-QiitaDrive</maml:linkText> <command:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Clear-QiitaCache</maml:linkText> <command:uri /> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |