npm package: @novopattern/dream-poc
Description: CLI for DReAM
Author: Jonatan Sombié @stomybexy
Latest version: 0.2.1

DReAM
=================

Developer Resources Auto-configuration Manager CLI

DReAM is an experimental tool that manages external resources you use in your app like databases.
For example, you can add a database like mongo in your project just by running: `dream add mongo`
and dream will deploy an instance of mongodb, inject the necessary environment variables and install
necessary client libraries preconfigured to connect to the previously deployed database  without you having
to manage a single connection string.
You can just start inserting and reading data.

For now, dream is experimental and work only for mongo as a proof of concept.
DReAM is designed to work with any language, but for now, it only works with nodejs and go.

<!-- toc -->
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->
# Usage
<!-- usage -->
```sh-session
$ npm install -g @novopattern/dream-poc
$ dream COMMAND
running command...
$ dream (--version)
@novopattern/dream-poc/0.2.1 darwin-x64 node-v18.0.0
$ dream --help [COMMAND]
USAGE
  $ dream COMMAND
...
```
<!-- usagestop -->
# Commands
<!-- commands -->
* [`dream add PACKAGE`](#dream-add-package)
* [`dream help [COMMAND]`](#dream-help-command)
* [`dream init [FILE]`](#dream-init-file)
* [`dream plugins`](#dream-plugins)
* [`dream plugins:install PLUGIN...`](#dream-pluginsinstall-plugin)
* [`dream plugins:inspect PLUGIN...`](#dream-pluginsinspect-plugin)
* [`dream plugins:install PLUGIN...`](#dream-pluginsinstall-plugin-1)
* [`dream plugins:link PLUGIN`](#dream-pluginslink-plugin)
* [`dream plugins:uninstall PLUGIN...`](#dream-pluginsuninstall-plugin)
* [`dream plugins:uninstall PLUGIN...`](#dream-pluginsuninstall-plugin-1)
* [`dream plugins:uninstall PLUGIN...`](#dream-pluginsuninstall-plugin-2)
* [`dream plugins update`](#dream-plugins-update)
* [`dream remove PACKAGE`](#dream-remove-package)

## `dream add PACKAGE`

add a package

```
USAGE
  $ dream add [PACKAGE]

DESCRIPTION
  add a package

EXAMPLES
  $ dream add mongo
```

_See code: [dist/commands/add.ts](https://github.com/novopattern/dream-cli-poc/blob/v0.2.1/dist/commands/add.ts)_

## `dream help [COMMAND]`

Display help for dream.

```
USAGE
  $ dream help [COMMAND] [-n]

ARGUMENTS
  COMMAND  Command to show help for.

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

DESCRIPTION
  Display help for dream.
```

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

## `dream init [FILE]`

initialize dream in a project

```
USAGE
  $ dream init [FILE] -p npm|yarn|go

FLAGS
  -p, --package-manager=<option>  (required) project's package manager
                                  <options: npm|yarn|go>

DESCRIPTION
  initialize dream in a project

EXAMPLES
  $ dream init -p yarn
```

_See code: [dist/commands/init.ts](https://github.com/novopattern/dream-cli-poc/blob/v0.2.1/dist/commands/init.ts)_

## `dream plugins`

List installed plugins.

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

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ dream plugins
```

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

## `dream plugins:install PLUGIN...`

Installs a plugin into the CLI.

```
USAGE
  $ dream 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
  $ dream plugins add

EXAMPLES
  $ dream plugins:install myplugin 

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

  $ dream plugins:install someuser/someplugin
```

## `dream plugins:inspect PLUGIN...`

Displays installation properties of a plugin.

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

ARGUMENTS
  PLUGIN  [default: .] Plugin to inspect.

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

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ dream plugins:inspect myplugin
```

## `dream plugins:install PLUGIN...`

Installs a plugin into the CLI.

```
USAGE
  $ dream 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
  $ dream plugins add

EXAMPLES
  $ dream plugins:install myplugin 

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

  $ dream plugins:install someuser/someplugin
```

## `dream plugins:link PLUGIN`

Links a plugin into the CLI for development.

```
USAGE
  $ dream 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
  $ dream plugins:link myplugin
```

## `dream plugins:uninstall PLUGIN...`

Removes a plugin from the CLI.

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

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ dream plugins unlink
  $ dream plugins remove
```

## `dream plugins:uninstall PLUGIN...`

Removes a plugin from the CLI.

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

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ dream plugins unlink
  $ dream plugins remove
```

## `dream plugins:uninstall PLUGIN...`

Removes a plugin from the CLI.

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

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ dream plugins unlink
  $ dream plugins remove
```

## `dream plugins update`

Update installed plugins.

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

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

DESCRIPTION
  Update installed plugins.
```

## `dream remove PACKAGE`

remove a package

```
USAGE
  $ dream remove [PACKAGE]

DESCRIPTION
  remove a package

EXAMPLES
  $ dream remove mongo
```

_See code: [dist/commands/remove.ts](https://github.com/novopattern/dream-cli-poc/blob/v0.2.1/dist/commands/remove.ts)_
<!-- commandsstop -->