Click here to Skip to main content
15,122,379 members
Articles / Programming Languages / C#
Posted 27 Oct 2002


269 bookmarked

C#/.NET Command Line Arguments Parser

Rate me:
Please Sign up or sign in to vote.
4.91/5 (104 votes)
5 Nov 2002MIT3 min read
Class to parse command line arguments and store/retrieve them.


Even with modern UI, we often need a way to start our programs with specific parameters. Command line arguments are helpful to provide those parameters without exposing them to everybody. When developing with .NET and C# you can get the command line arguments from your Main(string[] Args) function. Args is in fact an array containing all the strings separated by spaces entered in the command line. What the following class does is to transform this array of strings into a ready to use collection of key/value pairs. You can then easily find and get from this collection a specific value for one of your parameters (key).

The Arguments class

This class parses your command line arguments, find all parameters starting with -, -- or / and all the values linked. I assumed that a value could be separated from a parameter with a space, a : or a =. The parser also look for enclosing characters like ' or " and remove them. Of course if you have a value like 'Mike's house', only the first and last ' will be removed. To achieve its goal, the class relies heavily on the regular expressions capabilities of .NET. The first regular expression (^-{1,2}|^/|=|:) splits one argument into several parts:

  • the parameter
  • the value

This regular expression handles cases where only a parameter is present, only a value is present or if both are present. The program performs accordingly to the number of parts found. The second regular expression (^['"]?(.*?)['"]?$) is used to detect and remove all starting and trailing ' or " characters from a value. When all your arguments are parsed, retrieving a value from a parameter is as easy as writing MyValue=params["MyParam"]. If the parameter doesn't exist or was not in the command line then you will get a null reference you can test against.

using System;
using System.Collections.Specialized;
using System.Text.RegularExpressions;

namespace CommandLine.Utility
    /// <summary>
    /// Arguments class
    /// </summary>
    public class Arguments{
        // Variables
        private StringDictionary Parameters;

        // Constructor
        public Arguments(string[] Args)
            Parameters = new StringDictionary();
            Regex Spliter = new Regex(@"^-{1,2}|^/|=|:",

            Regex Remover = new Regex(@"^['""]?(.*?)['""]?$",

            string Parameter = null;
            string[] Parts;

            // Valid parameters forms:
            // {-,/,--}param{ ,=,:}((",')value(",'))
            // Examples: 
            // -param1 value1 --param2 /param3:"Test-:-work" 
            //   /param4=happy -param5 '--=nice=--'
            foreach(string Txt in Args)
                // Look for new parameters (-,/ or --) and a
                // possible enclosed value (=,:)
                Parts = Spliter.Split(Txt,3);

                // Found a value (for the last parameter 
                // found (space separator))
                case 1:
                    if(Parameter != null)
                            Parts[0] = 
                                Remover.Replace(Parts[0], "$1");

                            Parameters.Add(Parameter, Parts[0]);
                    // else Error: no parameter waiting for a value (skipped)

                // Found just a parameter
                case 2:
                    // The last parameter is still waiting. 
                    // With no value, set it to true.
                            Parameters.Add(Parameter, "true");

                // Parameter with enclosed value
                case 3:
                    // The last parameter is still waiting. 
                    // With no value, set it to true.
                    if(Parameter != null)
                            Parameters.Add(Parameter, "true");

                    Parameter = Parts[1];

                    // Remove possible enclosing characters (",')
                        Parts[2] = Remover.Replace(Parts[2], "$1");
                        Parameters.Add(Parameter, Parts[2]);

            // In case a parameter is still waiting
            if(Parameter != null)
                    Parameters.Add(Parameter, "true");

        // Retrieve a parameter value if it exists 
        // (overriding C# indexer property)
        public string this [string Param]

The test class

Here is an example of how to use the Arguments class. As usual, the code is available in the zip file.

using System;
using CommandLine.Utility;

namespace CommandLine
    /// <summary>
    /// Testing class
    /// </summary>
    class Test
        /// <summary>
        /// Main loop
        /// </summary>
        static void Main(string[] Args)
        // Command line parsing
        Arguments CommandLine=new Arguments(Args);

        // Look for specific arguments values and display 
        // them if they exist (return null if they don't)
        if(CommandLine["param1"] != null) 
            Console.WriteLine("Param1 value: " + 
            Console.WriteLine("Param1 not defined !");

        if(CommandLine["height"] != null) 
            Console.WriteLine("Height value: " + 
            Console.WriteLine("Height not defined !");

        if(CommandLine["width"] != null) 
            Console.WriteLine("Width value: " + 
            Console.WriteLine("Width not defined !");

        if(CommandLine["size"] != null) 
            Console.WriteLine("Size value: " + 
            Console.WriteLine("Size not defined !");

        if(CommandLine["debug"] != null) 
            Console.WriteLine("Debug value: " + 
            Console.WriteLine("Debug not defined !");

        // Wait for key
        Console.Out.WriteLine("Arguments parsed. Press a key");

Execution sample

I provided the following command line as the Arguments setting in the properties dialog of the Visual Studio .NET solution included in the ZIP file: -size=100 /height:'400' -param1 "Nice stuff !" --debug that command line produced the following output

Param1 value: Nice stuff !
Height value: 400
Width not defined !
Size value: 100
Debug value: true
Arguments parsed. Press a key...


In this article with saw how to parse, store and retrieve the arguments line of a .NET application. This class is versatile enough to handle a lot of different kind of arguments. Compatible with most of the forms we are used to (-param, --param or Windows /param). Thanks to the regular expressions for this. Using regular expressions allowed us to keep the Arguments class very small and the usage is very simple. Regular expressions are very powerful and can be used for most of your parsing needs (as far as speed is not the main concern).

Special thanks to: Benjamin, Guillaume and Sebastien for their support :o)

Happy Coding!!!


  • October 28, 2002 - v1.0 Initial release
  • November 6, 2002 - v1.1 Bug fix. Should be bug free now. Thanks to n2s for help.


This article, along with any associated source code and files, is licensed under The MIT License


About the Author

Software Developer (Senior) Siliconz Ltd
New Zealand New Zealand
Richard Lopes
Just Programmer

Comments and Discussions

QuestionPositional Parameters don't work Pin
snoopy00122-Feb-18 4:46
Membersnoopy00122-Feb-18 4:46 
PraiseExcellent ! Pin
h1403024-Dec-15 16:16
Memberh1403024-Dec-15 16:16 
QuestionArgs[0] as path Pin
NikolaB11-Nov-14 0:53
MemberNikolaB11-Nov-14 0:53 
QuestionAnother solution Pin
Alan M Donnelly12-May-14 12:46
MemberAlan M Donnelly12-May-14 12:46 
QuestionI love this command line parser Pin
raylitalo18-Feb-14 4:25
Memberraylitalo18-Feb-14 4:25 
GeneralMy vote of 5 Pin
urinspiration7-Jan-14 22:51
Memberurinspiration7-Jan-14 22:51 
GeneralMy vote of 5 Pin
Belgian Ducky12-Aug-13 23:19
MemberBelgian Ducky12-Aug-13 23:19 
Questiongood Pin
Hua Yujun6-Apr-13 22:48
MemberHua Yujun6-Apr-13 22:48 
SuggestionJust 3 lines Pin
Sven Johannsen22-Mar-13 5:01
MemberSven Johannsen22-Mar-13 5:01 
QuestionCommand line parser with linq Pin
masterluke18-Jan-13 23:54
Membermasterluke18-Jan-13 23:54 
GeneralMy vote of 5 Pin
Vincent Blais28-Nov-12 9:46
professionalVincent Blais28-Nov-12 9:46 
QuestionReally helpful Pin
missdeborah4-Jun-12 10:43
Membermissdeborah4-Jun-12 10:43 
SuggestionAnother simple Command Line Arguments Parser Pin
Member 14778522-Mar-12 6:08
MemberMember 14778522-Mar-12 6:08 
SuggestionArgument with space with file path as value fix PinPopular
tbare13-Sep-11 7:30
Membertbare13-Sep-11 7:30 
GeneralRe: Argument with space with file path as value fix Pin
hansmustermann9-Nov-12 4:59
Memberhansmustermann9-Nov-12 4:59 
GeneralRe: Argument with space with file path as value fix Pin
Matthias Schett3-Apr-13 5:18
MemberMatthias Schett3-Apr-13 5:18 
QuestionGreat class Pin
Shamaniac10-Jul-11 21:58
MemberShamaniac10-Jul-11 21:58 
GeneralVery Nicely Done!! Pin
raylitalo24-May-11 8:36
Memberraylitalo24-May-11 8:36 
GeneralMy vote of 4 Pin
Lakonier2-May-11 22:44
MemberLakonier2-May-11 22:44 
GeneralRevised code, extension method-ified w/filepath support Pin
PeteM6-Oct-10 13:53
MemberPeteM6-Oct-10 13:53 
GeneralRe: Revised code, extension method-ified w/filepath support Pin
tomidery14-Apr-11 5:41
Membertomidery14-Apr-11 5:41 
Generalpath as arguments Pin
roman30017824-Feb-10 4:13
Memberroman30017824-Feb-10 4:13 
GeneralRe: path as arguments Pin
Tomazaz16-Mar-10 1:10
MemberTomazaz16-Mar-10 1:10 
AnswerRe: path as arguments Pin
kaepten10-Jun-10 20:52
Memberkaepten10-Jun-10 20:52 
GeneralRe: path as arguments Pin
PeteM6-Oct-10 13:35
MemberPeteM6-Oct-10 13:35 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.