へっぽこプログラマーの備忘録
プログラムを中心とした個人的なメモ用のブログです。 タイトルは迷走中。
内容の保証はできませんのであしからずご了承ください。
menu
keyboard_arrow_up
Top
search
close
home
ホーム
computer
PC一般
construction
開発環境・ツール
code
プログラミング
home
ホーム
computer
PC一般
construction
開発環境・ツール
code
プログラミング
Home
›
C#
›
C# におけるコマンドライン引数の解析
2017/11/22
C# におけるコマンドライン引数の解析
update
event_note
label
.NET Core
label
.NET Framework
label
C#
C# でコマンドライン引数を解析する場合、今までだと自力で行ったりサードパーティーのパーサーを使ったりしていました。 しかし、現在では Microsoft が [Microsoft.Extensions.CommandLineUtils](https://www.nuget.org/packages/Microsoft.Extensions.CommandLineUtils/) というパーサーを用意してくれているので、それを使ってみます。
尚、.NET Core でも .NET Framework でも使えます。 ## 環境 - Visual Studio 2017 - .NET Core 2.0 - Microsoft.Extensions.CommandLineUtils 1.1.1 ## インストール NuGet パッケージマネージャーコンソールから以下のコマンドでインストールできます。 ```sh PM> Install-Package Microsoft.Extensions.CommandLineUtils ``` ## 簡単な使い方 ```cs using Microsoft.Extensions.CommandLineUtils; // 中略 static void Main(string[] args) { var app = new CommandLineApplication(throwOnUnexpectedArg: false) { // アプリケーション名(ヘルプの出力で使用される) Name = "CommandLineTest", }; // ヘルプ出力のトリガーとなるオプションを指定 app.HelpOption("-?|-h|--help"); app.OnExecute(() => { Console.WriteLine("Hello World!"); return 0; }); app.Execute(args); } ``` 動作内容は `onExecute` に定義します。 `onExecute` の引数は `Func
` なので、戻り値(エラーコード)として `int` の値を返す必要があります。 `onExecute` を定義したら `app.Execute` をコールすると実行されます。 引数には `Main` で受け取ったコマンドライン引数を渡します。 ### 実行結果 ```sh > CommandLineTest.exe ``` ```bat Hello World! ``` --- ```sh > CommandLineTest.exe --help ``` ```bat Usage: CommandLineTest [options] Options: -?|-h|--help Show help information ``` ## コマンドの追加 上記のコードにコマンドを追加してみます。 ```cs static void Main(string[] args) { var app = new CommandLineApplication(throwOnUnexpectedArg: false) { // アプリケーション名(ヘルプの出力で使用される) Name = "CommandLineTest", }; // ヘルプ出力のトリガーとなるオプションを指定 app.HelpOption("-?|-h|--help"); app.OnExecute(() => { Console.WriteLine("Hello World!"); return 0; }); app.Command("hoge", (command) => { // 説明(ヘルプの出力で使用される) command.Description = "Hogeを出力する"; // コマンドについてのヘルプ出力のトリガーとなるオプションを指定 command.HelpOption("-?|-h|--help"); // コマンドの引数(名前と説明を引数で渡しているが、これはヘルプ出力で使用される) var hogeArgs = command.Argument("[Hogeの引数]", "Hogeの引数の説明"); command.OnExecute(() => { var location = hogeArgs.Value != null ? $"引数あり {hogeArgs.Value}" : "引数なし"; Console.WriteLine("Hoge: " + location); return 0; }); }); app.Execute(args); } ``` 特に説明は不要かと思います。 尚、コマンドはネストして、サブコマンドなどを作ることもできます。 ### 実行結果 ```sh > CommandLineTest --help ``` ```bat Usage: CommandLineTest [options] [command] Options: -?|-h|--help Show help information Commands: hoge Hogeを出力する Use "CommandLineTest [command] --help" for more information about a command. ``` --- ```sh > CommandLineTest hoge --help ``` ```bat Usage: CommandLineTest hoge [arguments] [options] Arguments: [Hogeの引数] Hogeの引数の説明 Options: -?|-h|--help Show help information ``` --- ```sh > CommandLineTest hoge ``` ```bat Hoge: 引数なし ``` --- ```sh > CommandLineTest hoge piyo ``` ```bat Hoge: 引数あり piyo ``` ## オプションの指定 さらに上記のコードにオプションを追加してみます。 ```cs app.Command("hoge", (command) => { // 説明(ヘルプの出力で使用される) command.Description = "Hogeを出力する"; // コマンドについてのヘルプ出力のトリガーとなるオプションを指定 command.HelpOption("-?|-h|--help"); // コマンドの引数(名前と説明を引数で渡しているが、これはヘルプ出力で使用される) var hogeArgs = command.Argument("[Hogeの引数]", "Hogeの引数の説明"); // オプションの設定 var hogeOptions = command.Option("-o|--option
", "hogeのオプション", CommandOptionType.MultipleValue); command.OnExecute(() => { var location = hogeArgs.Value != null ? $"引数あり {hogeArgs.Value}" : "引数なし"; Console.WriteLine("Hoge: " + location); foreach (var value in hogeOptions.Values) { Console.WriteLine("Hogeのオプション: " + value); } return 0; }); }); ``` `CommandOptionType` については[こちら](https://docs.microsoft.com/en-us/dotnet/api/microsoft.extensions.commandlineutils.commandoptiontype?view=aspnetcore-1.1)に一覧があります。 何にも説明がありませんが、名前で分かると思います。 ### 実行結果 ```sh >CommandLineTest hoge -h ``` ```bat Usage: CommandLineTest hoge [arguments] [options] Arguments: [Hogeの引数] Hogeの引数の説明 Options: -?|-h|--help Show help information -o|--option
hogeのオプション ``` --- ```sh >CommandLineTest hoge piyo -o=foo -o=bar ``` ```bat Hoge: 引数あり piyo Hogeのオプション: foo Hogeのオプション: bar ``` ## 参考 URL - https://msdn.microsoft.com/ja-jp/magazine/mt763239.aspx - http://tnakamura.hatenablog.com/entry/2017/10/24/microsoft-extensions-commandlineutils - https://gist.github.com/iamarcel/8047384bfbe9941e52817cf14a79dc34
tweet
facebook
Pocket
B!
はてブ
LINE
chevron_left
chevron_right
Translate
Popular Posts
TortoiseGit でコミットメッセージを変更する
image
NO IMAGE
smbclient で session setup failed: NT_STATUS_LOGON_FAILURE が表示される
Docker for Windows の設定
image
NO IMAGE
マージ元ブランチとマージ先ブランチ
TortoiseGit でブランチ間の差分を見る
[Python] 文字列の判定で、None と空文字を同時に判定する
[Python] matplotlib で plot する際に "Tcl_AsyncDelete: async handler deleted by the wrong thread" というエラーがでる
[Python] Tesseract で OCR を行ったら `UnicodeEncodeError: 'ascii' codec can't encode characters` のエラーが表示された
image
NO IMAGE
GitLab Runner でクローンする URL を変更する
image
NO IMAGE
Visual Studio で文字がにじむ(ぼやける)
Labels
.NET Core
31
.NET Framework
17
.NET Standard
2
AdminLTE
1
AI
1
Apache
3
AppVeyor
2
AsciiDoc
3
ASP.NET Core
55
Atom
4
AWS
5
AWS Cloud9
4
blockdiag
1
Blogger
13
Bootstrap
3
C/C++
6
C#
106
CentOS
3
Chrome
1
Chronograf
3
chrony
1
Codecov
1
CSS
1
Docker
79
DokuWiki
4
Doxygen
1
draw.io
1
EasyTag
1
Electron
1
Electron.NET
2
Entity Framework Core
9
Excel
2
FFmpeg
3
Firefox
6
Flask
1
Git
19
GitBook
4
GitBucket
7
GitHub
7
GitLab
39
Go
1
Google
1
Google Cloud Platform
1
Grafana
13
GStreamer
2
HTML
5
IIS
8
InfluxDB
14
JavaScript
15
Jenkins
7
Linux
34
Log4View
1
MahApps.Metro
3
MaterialDesignInXamlToolkit
1
MkDocs
2
MongoDB
5
MVC
1
MVVM
6
nginx
3
NLog
3
Node.js
8
npm
1
NVIDIA
3
onvif
1
OpenAPI
2
OpenCV
4
OpenSSL
3
OpenVINO
2
ownCloud
2
pandas
1
Pine Script
1
PlantUML
5
Portainer
3
PowerShell
8
Prism
2
PySide
18
Python
86
PyTorch
1
RabbitVCS
1
Razor
3
Redmine
33
Redoc
1
remark.js
2
rocketchat
10
Ruby
3
scikit-learn
1
SignalR
1
Slack
1
Socket.IO
1
SonarQube
5
Sphinx
10
SQL Server
5
SQLite
1
StableDiffusion
1
Subversion
2
Swagger
1
Swarmpit
1
Syslog
3
Telegraf
6
Tesseract
3
TestLink
2
Tomcat
2
TortoiseGit
11
TortoiseSVN
2
Trading View
1
Traefik
3
Travis CI
1
Ubuntu
31
Visual Studio
39
Visual Studio Code
10
VSCode
8
Vue.js
8
Windows
62
Windows 10
5
Windows ADK
1
Windows API
2
Windows Embedded
4
wkhtmltopdf
2
Word
3
WPF
12
WSL
5
WSL2
5
Xamarin
1
xUnit
5
yaml
1
yolo
1
アプリケーション
1
デザインパターン
1
テスト
1
バッチファイル
2
プログラミング
4
ライセンス
1
暗号資産(仮想通貨)
1
英語
2
確定申告
1
機械学習
1
強化学習
1
雑記
1
書籍
1
数学
1
正規表現
1
Blog Archive
►
2024
(9)
►
4月
(2)
►
3月
(1)
►
2月
(5)
►
1月
(1)
►
2023
(30)
►
12月
(3)
►
11月
(5)
►
10月
(2)
►
9月
(1)
►
8月
(2)
►
7月
(4)
►
6月
(2)
►
5月
(3)
►
4月
(2)
►
3月
(2)
►
2月
(3)
►
1月
(1)
►
2022
(106)
►
12月
(5)
►
11月
(1)
►
10月
(3)
►
9月
(6)
►
8月
(7)
►
7月
(6)
►
6月
(13)
►
5月
(9)
►
4月
(15)
►
3月
(11)
►
2月
(14)
►
1月
(16)
►
2021
(85)
►
12月
(11)
►
11月
(6)
►
10月
(4)
►
9月
(10)
►
8月
(8)
►
7月
(4)
►
6月
(18)
►
5月
(7)
►
4月
(8)
►
3月
(2)
►
2月
(2)
►
1月
(5)
►
2020
(56)
►
12月
(1)
►
11月
(3)
►
10月
(3)
►
9月
(3)
►
8月
(3)
►
7月
(7)
►
6月
(7)
►
5月
(2)
►
4月
(6)
►
3月
(6)
►
2月
(3)
►
1月
(12)
►
2019
(92)
►
12月
(13)
►
11月
(9)
►
10月
(3)
►
9月
(2)
►
8月
(3)
►
7月
(5)
►
6月
(11)
►
5月
(6)
►
4月
(17)
►
3月
(9)
►
2月
(6)
►
1月
(8)
►
2018
(100)
►
12月
(1)
►
11月
(11)
►
10月
(8)
►
9月
(6)
►
8月
(10)
►
7月
(10)
►
6月
(8)
►
5月
(9)
►
4月
(8)
►
3月
(14)
►
2月
(4)
►
1月
(11)
▼
2017
(117)
►
12月
(14)
▼
11月
(20)
Visual Studio のビルド後イベントで配布用の ZIP ファイルを自動生成する
.NET アプリケーションを XCOPY 配置で配布する
ファイル選択ダイアログとフォルダ選択ダイアログ
GitHub と AppVeyor で .NET アプリケーションの継続的インテグレーションを行う
C# におけるコマンドライン引数の解析
Visual Studio で .NET Core + Electron.NET を使う
Firefox 57 用にアドオンのインストールと設定変更を行う
Node.js のインストールとプロキシの設定
GitLab CI で .NET Core の継続的インテグレーションを行う
GitLab をアップグレードしたら Redmine へのリンクが解除された
GitHub と Travis CI で .NET Core の継続的インテグレーションを行う
GitLab で LDAP 認証するとメールアドレスが勝手に設定されるのを直す
GitLab のバージョンアップを行った
GitLab のバックアップとリストア
Visual Studio 2017 Update 4 (15.4) で .NET Core プロジ...
ASP.NET Core におけるバリデーションの基本
[C#] 非同期メソッドを同期メソッドとして扱いたい場合
ASP.NET Core における css と js ファイルの Bundle と Minify
ASP.NET Core アプリケーションを外部に公開するための Windows ファイアウォールの設定
ASP.NET Core アプリケーションを IIS でホストする
►
10月
(17)
►
9月
(19)
►
8月
(10)
►
7月
(8)
►
6月
(3)
►
5月
(6)
►
4月
(5)
►
3月
(2)
►
2月
(8)
►
1月
(5)
►
2016
(91)
►
12月
(5)
►
11月
(9)
►
10月
(11)
►
9月
(9)
►
8月
(6)
►
7月
(14)
►
6月
(14)
►
5月
(11)
►
4月
(10)
►
3月
(2)
►
2015
(23)
►
12月
(4)
►
11月
(2)
►
10月
(8)
►
9月
(8)
►
7月
(1)
►
2013
(3)
►
11月
(1)
►
9月
(1)
►
7月
(1)
►
2012
(2)
►
7月
(1)
►
6月
(1)
►
2011
(1)
►
9月
(1)
►
2009
(1)
►
7月
(1)
►
2008
(2)
►
11月
(1)
►
7月
(1)
►
2007
(3)
►
10月
(3)