HiveSharp

Easy-peasy C# based scripting environment for your everyday tasks

Home | Download | Documentation | Donate

Command line reference

In case you are more of a command line than a UI type, HiveSharp has got you covered. The command line interface is implemented as "HiveSharp.exe", a command line application that is installed as part of the HiveSharp installation. You'll typically find it under "C:\Program Files (x86)\HiveSharp\SampleScripts". Note that it's not on the %PATH% environment variable by default.

The command line of "HiveSharp.exe" has the following format:

HiveSharp[.exe] {I|X|H} [--U] [--K] --M <module> --C <class> --E <method> [-<paramName> <paramValue>]*

The first argument is always the verb, i.e. the high-level action to perform. Currently, three verbs are supported, namely Inspect, eXecute and Help - hopefully, self-explanatory.

--U (--allowUnpublished) is a switch that allows the HiveSharp engine to access entities in the script that are not marked with the special Publish attribute (see Scripting runtime reference for context). Note that the UI version of HiveSharp will allow you to access any methods and therefore doesn't require a special switch to operate on undecorated modules, classes, methods and their parameters.

--K (--keepOpen) is a switch that keeps the HiveSharp command line window open after it's done executing. By default, it closes automatically to avoid interfering with any possible automation that may "HiveSharp.exe" may be included in.

--M (--module) specifies the relative or absolute path to the module (*.cs) to open.

--C (--class) specifies the name of the class to select.

--E (--method) specifies the name of the method to select.

All the arguments that follow the above and are prefixed with a single dash (-) as opposed to a double dash (--) are treated as arguments of the method to be invoked, specified by name rather than positionally.

You can experiment with the command line application by running it without arguments, with the Help verb or with a partial argument set. Its output should guide you towards understanding the various options it presents.

Back to Table of contents