Rgraph
=================

Rocketgraph CLI

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
[![CircleCI](https://circleci.com/gh/oclif/hello-world/tree/main.svg?style=shield)](https://circleci.com/gh/oclif/hello-world/tree/main)
[![GitHub license](https://img.shields.io/github/license/oclif/hello-world)](https://github.com/oclif/hello-world/blob/main/LICENSE)

<!-- toc -->
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->
# Usage
<!-- usage -->
```sh-session
$ npm install -g rgraph
$ rgraph COMMAND
running command...
$ rgraph (--version)
rgraph/0.1.12 darwin-arm64 node-v20.10.0
$ rgraph --help [COMMAND]
USAGE
  $ rgraph COMMAND
...
```
<!-- usagestop -->
# Commands
<!-- commands -->
* [`rgraph deploy PROJECT`](#rgraph-deploy-project)
* [`rgraph generate`](#rgraph-generate)
* [`rgraph help [COMMANDS]`](#rgraph-help-commands)
* [`rgraph plugins`](#rgraph-plugins)
* [`rgraph plugins:install PLUGIN...`](#rgraph-pluginsinstall-plugin)
* [`rgraph plugins:inspect PLUGIN...`](#rgraph-pluginsinspect-plugin)
* [`rgraph plugins:install PLUGIN...`](#rgraph-pluginsinstall-plugin-1)
* [`rgraph plugins:link PLUGIN`](#rgraph-pluginslink-plugin)
* [`rgraph plugins:uninstall PLUGIN...`](#rgraph-pluginsuninstall-plugin)
* [`rgraph plugins:uninstall PLUGIN...`](#rgraph-pluginsuninstall-plugin-1)
* [`rgraph plugins:uninstall PLUGIN...`](#rgraph-pluginsuninstall-plugin-2)
* [`rgraph plugins update`](#rgraph-plugins-update)

## `rgraph deploy PROJECT`

Deploy a serverless function. Use this in the directory of your project

```
USAGE
  $ rgraph deploy PROJECT

ARGUMENTS
  PROJECT  Project to deploy this function to

DESCRIPTION
  Deploy a serverless function. Use this in the directory of your project

EXAMPLES
  $ oex hello friend --from oclif
  hello friend from oclif! (./src/commands/hello/index.ts)
```

_See code: [src/commands/deploy/index.ts](https://github.com/RocketsGraphQL/rgraph/blob/v0.1.12/src/commands/deploy/index.ts)_

## `rgraph generate`

Generates a new instance of Rocketgraph project.

```
USAGE
  $ rgraph generate

DESCRIPTION
  Generates a new instance of Rocketgraph project.

EXAMPLES
  $ rgraph generate
```

_See code: [src/commands/generate.ts](https://github.com/RocketsGraphQL/rgraph/blob/v0.1.12/src/commands/generate.ts)_

## `rgraph help [COMMANDS]`

Display help for rgraph.

```
USAGE
  $ rgraph help [COMMANDS] [-n]

ARGUMENTS
  COMMANDS  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for rgraph.
```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.20/src/commands/help.ts)_

## `rgraph plugins`

List installed plugins.

```
USAGE
  $ rgraph plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ rgraph plugins
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.4.7/src/commands/plugins/index.ts)_

## `rgraph plugins:install PLUGIN...`

Installs a plugin into the CLI.

```
USAGE
  $ rgraph plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.
  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.


ALIASES
  $ rgraph plugins add

EXAMPLES
  $ rgraph plugins:install myplugin 

  $ rgraph plugins:install https://github.com/someuser/someplugin

  $ rgraph plugins:install someuser/someplugin
```

## `rgraph plugins:inspect PLUGIN...`

Displays installation properties of a plugin.

```
USAGE
  $ rgraph plugins:inspect PLUGIN...

ARGUMENTS
  PLUGIN  [default: .] Plugin to inspect.

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ rgraph plugins:inspect myplugin
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.4.7/src/commands/plugins/inspect.ts)_

## `rgraph plugins:install PLUGIN...`

Installs a plugin into the CLI.

```
USAGE
  $ rgraph plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.
  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.


ALIASES
  $ rgraph plugins add

EXAMPLES
  $ rgraph plugins:install myplugin 

  $ rgraph plugins:install https://github.com/someuser/someplugin

  $ rgraph plugins:install someuser/someplugin
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.4.7/src/commands/plugins/install.ts)_

## `rgraph plugins:link PLUGIN`

Links a plugin into the CLI for development.

```
USAGE
  $ rgraph plugins:link PLUGIN

ARGUMENTS
  PATH  [default: .] path to plugin

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Links a plugin into the CLI for development.
  Installation of a linked plugin will override a user-installed or core plugin.

  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
  command will override the user-installed or core plugin implementation. This is useful for development work.


EXAMPLES
  $ rgraph plugins:link myplugin
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.4.7/src/commands/plugins/link.ts)_

## `rgraph plugins:uninstall PLUGIN...`

Removes a plugin from the CLI.

```
USAGE
  $ rgraph plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ rgraph plugins unlink
  $ rgraph plugins remove
```

## `rgraph plugins:uninstall PLUGIN...`

Removes a plugin from the CLI.

```
USAGE
  $ rgraph plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ rgraph plugins unlink
  $ rgraph plugins remove
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.4.7/src/commands/plugins/uninstall.ts)_

## `rgraph plugins:uninstall PLUGIN...`

Removes a plugin from the CLI.

```
USAGE
  $ rgraph plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ rgraph plugins unlink
  $ rgraph plugins remove
```

## `rgraph plugins update`

Update installed plugins.

```
USAGE
  $ rgraph plugins update [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Update installed plugins.
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.4.7/src/commands/plugins/update.ts)_
<!-- commandsstop -->