Fix mischaracterization and usage of Optional parameters in command l…

…ine (#395) * fixed bug * Update command-reference.md
neo-project · Nov 27, 2023 · 3337229 · 3337229
1 parent ecb45e9
commit 3337229
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 18 deletions.
diff --git a/docs/command-reference.md b/docs/command-reference.md
@@ -55,13 +55,16 @@ Usage: neoxp create [Options] [Output]
 
 Arguments:
 [Options]:
+  -o|--output <OUTPUT>                    Name of .neo-express file to create
+                                          Default location is home directory as:
+                                          Linux: $HOME/.neo-express/default.neo-express
+                                          Windows: %UserProfile%\.neo-express\default.neo-express
   -c|--count <COUNT>                      Number of consensus nodes to create
                                           Default: 1
                                           Allowed values are: 1, 4, 7.
   -a|--address-version <ADDRESS_VERSION>  Version to use for addresses in this blockchain instance
                                           Default: 53
   -f|--force                              Overwrite existing data
-[Output]: name of .neo-express file to create (Default: ./default.neo-express)
 ```
 
 The `create` command is used to create a new Neo-Express blockchain network for local development
@@ -84,15 +87,14 @@ via the `--input` option.
 ## neoxp run
 
 ```
-Usage: neoxp run [Options] [NodeIndex]
+Usage: neoxp run [Options]
 
-Arguments:
 [Options]:
+  -n|--node-index <NODE_INDEX>                Index of node to run (Default: 0)
   -i|--input <INPUT>                          Path to neo-express data file
   -s|--seconds-per-block <SECONDS_PER_BLOCK>  Time between blocks
   -d|--discard                                Discard blockchain changes on shutdown
   -t|--trace                                  Enable contract execution tracing
-[NodeIndex]: Index of node to run (Default: 0)
 ```
 
 Once created, a Neo-Express blockchain network is started with the `run` command. The consensus
@@ -118,13 +120,12 @@ the blockchain network is shut down.
 ## neoxp stop
 
 ```
-Usage: neoxp stop [Options] [NodeIndex]
+Usage: neoxp stop [Options]
 
-Arguments:
 [Options]:
-  -i|--input <INPUT>  Path to neo-express data file
+  -n|--node-index <NODE_INDEX>    Index of node to stop (Default: 0)
+  -i|--input <INPUT>              Path to neo-express data file
   -a|--all            Stop all nodes
-[NodeIndex]: Index of node to stop (Default: 0)
 ```
 
 When running in a terminal window, neo-express can be shutdown via standard CTRL-C or CTRL-BREAK operations.
@@ -135,14 +136,13 @@ nodes in the network.
 ## neoxp reset
 
 ```
-Usage: neoxp reset [Options] [NodeIndex]
+Usage: neoxp reset [Options]
 
-Arguments:
 [Options]:
-  -i|--input <INPUT>  Path to neo-express data file
-  -f|--force          Overwrite existing data
-  -a|--all            Reset all nodes
-[NodeIndex]: Index of node to reset (Default: 0)
+  -n|--node-index <NODE_INDEX>  Index of node to reset (Default: 0)
+  -i|--input <INPUT>            Path to neo-express data file
+  -f|--force                    Overwrite existing data
+  -a|--all                      Reset all nodes
 ```
 
 A Neo-express blockchain network can be reset back to its genesis block via the `reset` command. This

diff --git a/src/neoxp/Commands/CreateCommand.cs b/src/neoxp/Commands/CreateCommand.cs
@@ -29,7 +29,7 @@ public CreateCommand(ExpressChainManagerFactory chainManagerFactory, IFileSystem
             this.txExecutorFactory = txExecutorFactory;
         }
 
-        [Argument(0, Description = $"Name of {EXPRESS_EXTENSION} file to create\nDefault location is home directory as:\nLinux: $HOME/.neo-express/{DEFAULT_EXPRESS_FILENAME}\nWindows: %UserProfile%\\.neo-express\\{DEFAULT_EXPRESS_FILENAME}")]
+        [Option(Description = $"Name of {EXPRESS_EXTENSION} file to create\nDefault location is home directory as:\nLinux: $HOME/.neo-express/{DEFAULT_EXPRESS_FILENAME}\nWindows: %UserProfile%\\.neo-express\\{DEFAULT_EXPRESS_FILENAME}")]
         internal string Output { get; set; } = string.Empty;
 
         [Option(Description = "Number of consensus nodes to create (Default: 1)")]

diff --git a/src/neoxp/Commands/ResetCommand.cs b/src/neoxp/Commands/ResetCommand.cs
@@ -23,7 +23,7 @@ public ResetCommand(ExpressChainManagerFactory chainManagerFactory)
             this.chainManagerFactory = chainManagerFactory;
         }
 
-        [Argument(0, Description = "Index of node to reset")]
+        [Option(Description = "Index of node to reset")]
         internal int? NodeIndex { get; }
 
         [Option(Description = "Path to neo-express data file")]

diff --git a/src/neoxp/Commands/RunCommand.cs b/src/neoxp/Commands/RunCommand.cs
@@ -23,7 +23,7 @@ public RunCommand(ExpressChainManagerFactory chainManagerFactory)
             this.chainManagerFactory = chainManagerFactory;
         }
 
-        [Argument(0, Description = "Index of node to run")]
+        [Option(Description = "Index of node to run")]
         internal int NodeIndex { get; init; } = 0;
 
         [Option(Description = "Path to neo-express data file")]

diff --git a/src/neoxp/Commands/StopCommand.cs b/src/neoxp/Commands/StopCommand.cs
@@ -23,7 +23,7 @@ public StopCommand(ExpressChainManagerFactory chainManagerFactory)
             this.chainManagerFactory = chainManagerFactory;
         }
 
-        [Argument(0, Description = "Index of node to stop")]
+        [Option(Description = "Index of node to stop")]
         internal int? NodeIndex { get; }
 
         [Option(Description = "Path to neo-express data file")]