# @r2r/api-definition

Latest version **0.0.3** (published 2019-12-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install @r2r/api-definition
pnpm add @r2r/api-definition
yarn add @r2r/api-definition
bun add @r2r/api-definition
```

## Health

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

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2019-12-21 |
| First published | 2019-12-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 3.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Pacharapol Withayasakpunt |
| Maintainers | patarapolw |

## Links

- npm: https://www.npmjs.com/package/@r2r/api-definition
- Repository: https://github.com/patarapolw/r2r-cli
- Homepage: https://github.com/patarapolw/r2r-cli#readme
- Issues: https://github.com/patarapolw/r2r-cli/issues
- npm.io page: https://npm.io/package/@r2r/api-definition

## Recent versions

- 0.0.3 (latest) — 2019-12-21

## README

# r2r-cli

Repeat Until You Can Recall

## Installation

```
yarn add @r2r/cli
```

## Usage

```
r2r <root>

Create or open in r2r

Positionals:
  root  Run as <root>/user.r2r                                         [string]

Options:
  --version       Show version number                                  [boolean]
  --filename, -f  Custom filename to open, including the extension, such as
                  custom.r2r                               [default: "user.r2r"]
  --port          Server port to open for R2r server          [default: "48000"]
  --help          Show help                                            [boolean]
```

## Associated folders

- `/media` will be created. You can put media files here (reference with `/media/filename.ext`)
- `/tmp` will be created, and will be deleted when the program ended

## How is this created / works?

This is made using [Lerna](https://lerna.js.org/) and [Vue CLI](https://cli.vuejs.org/) with Express.js server and [ResTyped](https://github.com/rawrmaan/restyped)
- So, there is actually three repos, controlled by Lerna
  - Vue CLI-based front-end repo
  - Express.js repo
  - API definition repo

## Installation in development mode

- Git clone
- Install Yarn, and Lerna, run

```
yarn
yarn bootstrap
yarn build
cd packages/cli
yarn link
```

- Now, you can use it anywhere with `yarn link @r2r/cli` and in `package.json` script section, `r2r <root>`

---
_Source: https://npm.io/package/@r2r/api-definition · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._