# react-reality-cli

> Command Line utility for react-reality

Latest version **1.0.0** (published 2018-07-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-reality-cli
pnpm add react-reality-cli
yarn add react-reality-cli
bun add react-reality-cli
```

Provides the commands `rr`, `react-reality`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2018-07-04 |
| First published | 2018-07-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 9.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Ray Deck |
| Maintainers | raydeck |
| Keywords | arkit, ar, react, react-native |

## Links

- npm: https://www.npmjs.com/package/react-reality-cli
- Repository: https://github.com/rhdeck/react-reality-cli
- Homepage: https://github.com/rhdeck/react-reality-cli#readme
- Issues: https://github.com/rhdeck/react-reality-cli/issues
- npm.io page: https://npm.io/package/react-reality-cli

## Dependencies (3)

- [commander](https://npm.io/package/commander.md) ^2.15.1
- [recursive-copy](https://npm.io/package/recursive-copy.md) ^2.0.9
- [react-native-cli](https://npm.io/package/react-native-cli.md) ^2.0.1

## Alternatives

- [@mdxeditor/editor](https://npm.io/package/@mdxeditor/editor.md) — 962.4K weekly downloads
- [mmdb-lib](https://npm.io/package/mmdb-lib.md) — 680.9K weekly downloads
- [playcanvas](https://npm.io/package/playcanvas.md) — 36.2K weekly downloads
- [@glw907/cairn-cms](https://npm.io/package/@glw907/cairn-cms.md) — 967 weekly downloads
- [markdown-to-confluence](https://npm.io/package/markdown-to-confluence.md) — 103 weekly downloads

## Recent versions

- 1.0.0 (latest) — 2018-07-04

## README

# react-reality-cli

Command line interface for [react-reality](https://github.com/rhdeck/react-reality) projects

# Installation

```bash
yarn global add rhdeck/react-reality-cli
```

**or**

```bash
npm i g rhdeck/react-reality-cli
```

# Usage

## init

Create a new react-reality project

```bash
react-reality init myproject
```

or use the short alias:

```bash
rr init myproject
```

**Fun Fact** You can use `rr` as an alias for any of your `react-native` commands. `rr run-ios` helps, and is shorter!

## Templates

Specify the react-reality template you want to use for faster initialization:

```bash
react-reality init myproject --template <mytemplate>
```

or try the short version

```bash
rr init myproject -t <mytemplate>
```

### Pre-Built Templates

To help with learning react-reality, some basic apps are available as templates

#### holokit

Deploys a package designed for use with [HoloKit](https://holokit.io) heads-up stereoscopic display.

```bash
rr init myproject -t holokit
```

### URL

Any url specified with a file://, http:// or https:// scheme will reference a react-reality template a that location.

```bash
rr init myproject -t https://github.com/rhdeck/react-reality-template-holokit
```

#### npm scoped project

Any argument prefixed with a @ and containing a slash is assumed to be a scoped npm project, in the form @scope/project. Passes through to npm

```bash
rr init myproject -t @myscope/mytemplate
```

#### GitHub repository

Any argument containing a slash (that does not start with the @) is assumed to refer to a github repository, and builds a https url to access it.

```bash
rr init myproject -t rhdeck/react-reality-template-holokit
```

#### NPM projects

Any other string tries to build a URL from NPM with the prefix "react-reality-template-", like a react-native template would.

```bash
rr init myproject -t holokit
```

#### Note on building templates of your own

Templates parallel the build system from react-native. They must contain:

1.  `package.json` used for identification only. Should include a name and version.
2.  `dependencies.json` indicating dependencies that should be added to the project. (should include the react-reality package and react-native-swift at a minimum)
3.  Any other files you want copied into your package that would override the core react-native files. Usually `App.js` is defined here, since it is the center of the app experience.

**Note** Templates are installed by first adding then removing from your dependencies. So you will not find them in your project post-install.

---
_Source: https://npm.io/package/react-reality-cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._