https://github.com/squareys/heyvr-cli
CLI tool to publish WebXR games to heyVR from CI/CD.
https://github.com/squareys/heyvr-cli
Last synced: 5 months ago
JSON representation
CLI tool to publish WebXR games to heyVR from CI/CD.
- Host: GitHub
- URL: https://github.com/squareys/heyvr-cli
- Owner: Squareys
- License: mit
- Created: 2023-10-08T06:45:58.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-06T16:41:22.000Z (over 2 years ago)
- Last Synced: 2025-04-06T17:42:33.388Z (about 1 year ago)
- Language: JavaScript
- Size: 63.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## heyVR CLI Tool
Easy to use CLI tool to publish WebXR games to
[heyVR](https://heyvr.io/) from CI/CD.
The command will check all arguments upfront to
reduce CI config iterations.
## Setup
Install the command in your CI scripts:
```sh
npm i -g heyvr-cli
```
## Authentication
The command expects a `HEYVR_ACCESS_TOKEN` variable
in the environment. Make sure to keep it safe via
CI secrets.
Create an access token [in your developer account settings](https://heyvr.io/account/settings).
## Usage
The command can be used as follows:
```
heyvr --version --gameId
version x.y.z, converted into 'minor'/'major'/'p
atch'
gameId Game ID for heyVR.
path Path to the game, index.html required at
root.
Default deploy/ or public/.
The command expects 'HEYVR_ACCESS_TOKEN' environm
ent
variable for authentication.
```
### version (required)
heyVR expects you to pass `major`, `minor`, `patch`
instead of an absolute version to enforce semantic
versioning.
Since this is really inconvenient for tagging from
CI, the tool will automatically convert the version
passed from `x.y.z` to the correct increment by
detecting `.0` suffixes:
- `x.0.0` => `major`
- `x.y.0` => `minor`
- `x.y.z` => `patch`
## gameId (required)
The game id of your game on heyVR.
### path
By default `deploy/` is uploaded. If not found,
`public/` is uploaded.
You can override this behavior by passing an explicit
`--path` argument.
The given path needs to contain an `index.html`.
### sdkVersion
Default `1`.
## License
MIT License, see `LICENSE` for more information.