Jump to content
  • Vectorworks Updater Command Line Guide


    jblock

    Updated 3/19/2020 

     

    The Vectorworks Updater can be used in two modes: GUI mode and CLI mode. GUI mode is what most users use and guides them through any updates or other operations via buttons, menus, and other visual elements. 

    The CLI performs the same functions as the GUI but via the command line. 

    The CLI is accessed through calling a script file instead of the main exe/app of the Updater. You can have it show help by: 

     

    Windows: "c:\Program Files\Vectorworks 2020\Vectorworks 2020 Updater\resources\cli.bat" -h 

     

    MacOS: /Applications/Vectorworks\ 2020/Vectorworks\ 2020\ Updater.app/Contents/Resources/cli.sh -h 

     

    On both platforms, the help command prints the usage help: 

     

    Screen Shot 2021-03-24 at 5.11.51 PM.png

     

    For help on a specific command, you can use the arguments -h <command>, such as: 

     

    Windows: "c:\Program Files\Vectorworks 2020\Vectorworks 2020 Updater\resources\cli.bat" check -h 

     

    MacOS: /Applications/Vectorworks\ 2020/Vectorworks\ 2020\ Updater.app/Contents/Resources/cli.sh check -h 

     

    Here is a quick description of the commands: 

     

    • check: Prints out some basic info on your version and says whether there’s an update available 

    • check-simple: returns 0 or 1 based on if an update is available or not. This is how VW calls to check for updates. 

    • repair: Checks that every file that’s supposed to be installed is present and valid. Fixes any problems that it finds. 

    • download-generic-update: Downloads a .vwupdate file that can be used to update Vectorworks while offline or on multiple machines. 

    • download-update: Downloads a more specific (and smaller) .vwupdate file that can be used to update Vectorworks from a specific version to a specific version. 

    • update: Updates Vectorworks. Used to do a normal update, or use a .vwupdate file with the –input option. 

    • download-latest-updater: This can be used to download an updated Vectorworks Updater package. This is done automatically at startup in the GUI. 

     

    Again, for any of these commands there is further help if you append -h to the command as in: 

     

    Windows: "c:\Program Files\Vectorworks 2020\Vectorworks 2020 Updater\resources\cli.bat" check -h 

     

    MacOS: /Applications/Vectorworks\ 2020/Vectorworks\ 2020\ Updater.app/Contents/Resources/cli.sh check -h 

     

    Known Issues: 

    1) The updater may complain about not finding “CommonDir” on Windows. It will show an error such as: 

     

    Could not find a path for the update location 'commonDir'. To correct this please run this again with the arguments -L commonDir:<path> with <path> being the correct directory, or contact support 

     

    In this case, you can supply commonDir as follows: 

     

    "c:\Program Files\Vectorworks 2020 SP2 Updater Cli\Vectorworks 2020 Updater\resources\cli.bat" -L "commonDir:\Program Files\Common Files" -h 

     

    Please note the quotes (due to spaces in the path). Also note no drive letter supplied. There is currently a bug passing a drive letter, which is fixed in newer updaters. 



      Report Article


    User Feedback


    There are no comments to display.



    Join the conversation

    You can post now and register later. If you have an account, sign in now to post with your account.
    Note: Your post will require moderator approval before it will be visible.

    Guest
    Add a comment...

    ×   Pasted as rich text.   Restore formatting

      Only 75 emoji are allowed.

    ×   Your link has been automatically embedded.   Display as a link instead

    ×   Your previous content has been restored.   Clear editor

    ×   You cannot paste images directly. Upload or insert images from URL.


 

7150 Riverwood Drive, Columbia, Maryland 21046, USA   |   Contact Us:   410-290-5114

 

© 2018 Vectorworks, Inc. All Rights Reserved. Vectorworks, Inc. is part of the Nemetschek Group.

×
×
  • Create New...