fxr – CLI tool for Firefox Reality

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

Usage

On your PC machine, first ensure Node.js is installed.

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

npm install -g fxr
fxr

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

fxr --help
fxr help

First-time experience for the Oculus Go VR headset

1. Ensure your headset has the Oculus mobile-companion app installed. Go to https://www.oculus.com/setup/ from your iOS or Android device.

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

3. On your PC machine, ensure Node.js is installed.

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

   npm install -g fxr

5. To download and install the latest version of the Firefox 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 enter Developer 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

Commands

To get a list of all commands and options:

fxr --help

fxr launch <url> [options]

To launch a URL in Firefox Reality:

fxr launch http://example.com/

CLI development

To work on improving the fxr 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 [email protected]:MozillaReality/fxr-cli.git
   cd fxr-cli

2. Install the Node.js dependencies:

   npm install

3. Run the CLI:

   node index.js

Maintaining this project

To freeze master at a new version, run these commands:

npm run publish

License

Copyright 2018 Mozilla Corporation

Licensed 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.0

Unless required by applicable law or agreed to in writing, software
distributed 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 and
limitations under the License.