Repository files navigation

A command-line tool for installing and automating theFirefox Reality virtual-reality browser.

On your PC machine, first ensureNode.js is installed.

To install thefxr tool on your machine, run this in your command-line terminal (e.g.,Terminal inApplications > Utilities on macOS):

npm install -g fxrfxr

To see all the various options with example commands, run any of these commands:

fxr --helpfxrhelp

1. Ensure your headset has the Oculus mobile-companion app installed. Go tohttps://www.oculus.com/setup/ from youriOS orAndroid device.

2. EnableDeveloper Mode in the Oculus mobile-companion app:Settings > Oculus Go (• Connected) > More Settings > Developer Mode > Developer mode

3. On your PC machine, ensureNode.js is installed.

4. Run this in your command-line terminal (e.g.,Terminal inApplications > Utilities on macOS):

   npm install -g fxr

5. To download and install the latest version of theFirefox Reality browser to your VR headset:

   💡TIP: Put your finger in front of the proximity sensor on the Oculus Go headset. Then, press the volume-left (top-left) button to enterDeveloper Mode.

   Run this command in your terminal:

   fxr install

6. To launch a URL in the browser, run this command in your terminal:

   fxr launch https://mzl.la/2NVWRyE

To get a list of all commands and options:

fxr --help

To launch a URL in Firefox Reality:

fxr launch http://example.com/

To work on improving thefxr CLI in this repository, first ensure you've set up the project and installed the dependencies:

1. Clone this git repository, and open the directory created:

   git clone git@github.com:MozillaReality/fxr-cli.gitcd fxr-cli

2. Install theNode.js dependencies:

   npm install

3. Run the CLI:

   node index.js

To freezemaster at a new version, run these commands:

npm run publish

Copyright 2018 Mozilla CorporationLicensed under the Apache License, Version 2.0 (the "License");you may not use this file except in compliance with the License.You may obtain a copy of the License at    http://www.apache.org/licenses/LICENSE-2.0Unless required by applicable law or agreed to in writing, softwaredistributed under the License is distributed on an "AS IS" BASIS,WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.See the License for the specific language governing permissions andlimitations under the License.