The only command that you need to remember is
springboardvr-cli push directory title:channel
directoryis what you want to upload. It can also be a .zip file.
titleis the project you're uploading (to get the name of your titles run
channelis which slot you're uploading it to
If you push the same directory twice:
These are two extreme cases — most of the time, you'll be somewhere in the middle, with maybe 5% to 20% fresh data in a push, saving 80% to 95% (more with compression) of your data/time/internet bandwidth.
Pushing to the same channel again will update that file, once the build is processed.
By default, the SpringboardVR backend will generate a constantly-increasing integer version number for your builds, for each channel.
However, if you're already generating your own build number, you should
pass it to springboardvr-cli with the
springboardvr-cli push mytitle titlename:windows --userversion 1.1.0
You can also instruct springboardvr-cli to read the version number from a given file, if it fits your workflow better:
springboardvr-cli push mytitle titlename:windows --userversion-file buildnumber.txt
buildnumber.txt file should contain a single line with the
version or build number, in UTF-8 without BOM.
User-provided version numbers don't have any particular format - the ordering SpringboardVR uses is the one builds are uploaded in.
Before pushing a build it is a good idea to validate the folder you will push. This command will check the manifest (if you have one) and walk through the folder to find the target executable.
springboardvr-cli validate mytitle
mytitle is the location of your title. This should provide some information about the build
and how it will be launched. More information about validation can be seen here.
Note: This is an experimental feature.
If you want to validate a build was pushed correctly first check its status with;
springboardvr-cli status mytitle
mytitle is the 'slug' for your title. This command should provide a table of the
channels, uploads, builds, build status' and versions of your title.
Once the build status is complete you can fetch the title to your machine with the command:
springboardvr-cli fetch mytitle:channel destination
mytitleis the 'slug' of the title you are fetching.
channelis which slot you are uploading to (
windowsonly for now)
destinationis the location to download the title to. It should be an empty directory.
Now try to launch that title with;
springboardvr-cli launch title_folder mytitle:channel
title_folderis the folder holding the newest install of the title,
mytitleis the slug of the title to be launched, and
channelis the channel of the title to be launched (windows!).
If title and channel are not provided the cli will list the titles you develop and prompt you to enter the title and channel.
This launch will only work if
title_folder contains the latest build for the given title from the SpringboardVR server.
springboardvr-cli push does a lot of work, most of it in parallel:
By design, progress bar shown by
springboardvr-cli push has two parts:
Neither of these bars jump back. The half-tone bar may pause, waiting for the full bar bar to catch up: this means springboardvr-cli is waiting to send the patch data it has already generated before scanning more files, and it helps keeping memory usage reasonable.
The estimated time remaining is to be taken with a grain of salt, as are all ETAs.