WVS Command Line

Installing

The WVS command line utility is installed when you install the WVS Desktop Client. Just follow the instructions on wvs.io to install the desktop client and when that process is finished, you will be ready to use the WVS command line.

Authenticating

Just like logging into a website, you must authenticate the wvs command line before you can start issuing most commands. You need to do this the first time you use the CLI and whenever your login into your browser expires (e.g. you deleted cookies, or waited too long between uses). Generally, after the first time you authenticate, you do not need to worry about it for quite a while.

Currently, authenticating the WVS command line is a two-step process: * First, open the WVS Desktop client and make sure you are logged in there. If you are logged in then great. You are done here. * Next, run “wvs authenticate” from the command line. It will open a browser window and ask you to authenticate there. When done, close the tab/window. You are now ready to use the command line.

Both authentication steps use your regular wvs.io login.

Using

Type “WVS” into command line to see the list of commands available to you. At the time of writing this article, this is what you should see:

Next, navigate to the folder you want to be working in. If you’re working on a pre-existing project you can type “wvs project status”. See example below

If you don’t already have a project in WVS, you have two options. Your first option is to create a brand new project using “wvs project create” You have two flags you must provide when using WVS project create. The first is the name “–name” and the second is the template “–template” To see a list of templates simply type “wvs project create –list” at the time of writing this you should see something like this -

Here’s an example of a filled out command with all the proper flags:

For Additional information on “wvs project create” you can use “wvs project create –help”

The other way you can create a project is by turning an existing project into a wvs project with “wvs project import”

Core Flow

Once you have your project set up, you’re ready to start a changelist.

Make sure you have navigated in command prompt to the newly created folder

Start your changelist by typing in “wvs changelist begin” you must provide a name for the changelist with the flag –name. Here is an example of the correct syntax -

Now you’re ready to grab the files you wish to work on. To do this you’re going to use the “wvs changelist grab” command. Here is an example of the command used properly when trying to grab multiple files.

You can also choose to grab entire directories and as many as you’d like. Once you grab a file no one else can work on that file until you push your current changelist.

At this point, you’re free to start working on your files.

When you’re ready to send your changes back to the cloud, you’ll use the “wvs changelist finish” command. No additional syntax is required.