Example of Command Line Sequence

The commands sequences suggestions below are example tasks that can be performed using the CLI. They provide commands names and order to perform the nominated task and require further configuration to run. Use the Command Designer to build the actual command will the required parameters and values.


  • Open an existing View with filtered data:

BimSens --project --source --activate --filter


  • Email a Navisworks render of a colour filtered model

"Navisworks Min Latest" --nw-file --project --source --activate --color --email


  • Merge a csv file into an existing dataset (e.g. SQL table)

BimSens --project --source --activate --transfer


  • Create a new project reading a file

BimSens --dataview-quick

Examples of Command Line Pipeline

The commands suggestions below are actual example output and can run once the <placeholder argument(s)> have been replaced with values valid on the executing machine.


  • Create a new Project pointing at a text file in classical BimSens (Batch file mode)

"C:\Program Files (x86)\BimSens\BimSens.Api.Automation.exe" BimSens -P MyProject -S "BimSensTextDataSource.TextDataSource" -D -SourceFilePath="<your file path>"


  • Open a Project in Navisworks Simulate if available, Manage otherwise, latest version on the machine, runs a colour filter and saves the output to a dated folder (Batch file mode)

"C:\Program Files (x86)\BimSens\BimSens.Api.Automation.exe" "Navisworks Min Latest" --nw-file "<your model file>" -p "<your bimsens project file>" -c "<your filter name>" -o "<your filepath, use {0:format} to add date/time stamp where format is a combination of yyyy-MM-dd HH-mm-ss>" -background=255,255,255 -key=BottomRight


  • Connects to a BIMWatcher published site in Navisworks Manage 2020, opens a file, creates an IdMatch and color filter and applies it (Url file mode)

bimsens://"Navisworks Manage 2020" -Q "https://bimwatcher.com/viewer/r?s=ezpyZXBvcnQvaWQgI3V1aWQgIjYzMmQ0MjhhLWY0OGItNDFlZS1iN2FiLTI2NGQ4NGVhM2E3MSJ9" --nw-file "<your model file>" -l {\"c\":\"ElementId\",\"g\":\"Element\",\"p\":\"Id\"} -C "[{\"v\":\"Walls\",\"c\":\"pink\"},{\"v\":\"Structural Columns\",\"c\":\"green\"}]" -target="Type" -apply -all


Note: some sequences may need to be escaped for special characters; use the Command Designer to build valid requests properly escaped