npm package: @novodream/cli-poc
Description: CLI for DReAM
Author: DReAM team
Latest version: 0.43.0

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

Developer Resources Auto-configuration Manager CLI

<!-- toc -->
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->
# Usage
<!-- usage -->
```sh-session
$ npm install -g @novodream/cli-poc
$ dream COMMAND
running command...
$ dream (--version)
@novodream/cli-poc/0.43.0 darwin-arm64 node-v20.18.2
$ dream --help [COMMAND]
USAGE
  $ dream COMMAND
...
```
<!-- usagestop -->
# Commands
<!-- commands -->
* [`dream add PACKAGE`](#dream-add-package)
* [`dream delete-env NAME`](#dream-delete-env-name)
* [`dream down`](#dream-down)
* [`dream help [COMMAND]`](#dream-help-command)
* [`dream init [PROJECTID]`](#dream-init-projectid)
* [`dream login [SERVER]`](#dream-login-server)
* [`dream logout`](#dream-logout)
* [`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 reset`](#dream-plugins-reset)
* [`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 run CMD`](#dream-run-cmd)
* [`dream set-env [NAME] [VALUE]`](#dream-set-env-name-value)
* [`dream set-private-key FILE`](#dream-set-private-key-file)
* [`dream set-public-key FILE`](#dream-set-public-key-file)
* [`dream up`](#dream-up)

## `dream add PACKAGE`

add a package

```
USAGE
  $ dream add PACKAGE [-D] [--from <value>]

ARGUMENTS
  PACKAGE  package to add

FLAGS
  -D, --dev           add package as dev dependency
      --from=<value>  id of the project to add the package from

DESCRIPTION
  add a package

EXAMPLES
  $ dream add mongo
```

_See code: [src/commands/add.ts](https://github.com/novodream/cli-poc/blob/v0.43.0/src/commands/add.ts)_

## `dream delete-env NAME`

remove environment variable from workspace

```
USAGE
  $ dream delete-env NAME -w <value> [-p <value>]

ARGUMENTS
  NAME  name of environment variable

FLAGS
  -p, --project=<value>    project to remove environment variable from
  -w, --workspace=<value>  (required) workspace to remove environment variable from

DESCRIPTION
  remove environment variable from workspace

EXAMPLES
  $ dream delete-env -w dev MY_VAR

  $ dream delete-env -w dev -p my_project_id MY_VAR
```

_See code: [src/commands/delete-env.ts](https://github.com/novodream/cli-poc/blob/v0.43.0/src/commands/delete-env.ts)_

## `dream down`

describe the command here

```
USAGE
  $ dream down [-s <value>]

FLAGS
  -s, --select=<value>...  [default: ] select a specific packages to provision

DESCRIPTION
  describe the command here

EXAMPLES
  $ dream down
```

_See code: [src/commands/down.ts](https://github.com/novodream/cli-poc/blob/v0.43.0/src/commands/down.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/v6.0.18/src/commands/help.ts)_

## `dream init [PROJECTID]`

initialize dream in a project

```
USAGE
  $ dream init [PROJECTID] -w <value>

ARGUMENTS
  PROJECTID  project id

FLAGS
  -w, --workspace=<value>  (required) Workspace name

DESCRIPTION
  initialize dream in a project

EXAMPLES
  $ dream init demo-app
```

_See code: [src/commands/init.ts](https://github.com/novodream/cli-poc/blob/v0.43.0/src/commands/init.ts)_

## `dream login [SERVER]`

Login to DReAM server

```
USAGE
  $ dream login [SERVER] [-t <value>]

ARGUMENTS
  SERVER  [default: https://api.dreampoc.dev] server to login to

FLAGS
  -t, --token=<value>  token to use

DESCRIPTION
  Login to DReAM server

EXAMPLES
  $ dream login https://dreamcloud.io
```

_See code: [src/commands/login.ts](https://github.com/novodream/cli-poc/blob/v0.43.0/src/commands/login.ts)_

## `dream logout`

describe the command here

```
USAGE
  $ dream logout

DESCRIPTION
  describe the command here

EXAMPLES
  $ dream logout
```

_See code: [src/commands/logout.ts](https://github.com/novodream/cli-poc/blob/v0.43.0/src/commands/logout.ts)_

## `dream plugins`

List installed plugins.

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

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ dream plugins
```

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

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

Installs a plugin into the CLI.

```
USAGE
  $ dream plugins add plugins:install PLUGIN...

ARGUMENTS
  PLUGIN...  Plugin to install.

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

GLOBAL FLAGS
  --json  Format output as json.

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 add myplugin 

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

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

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ dream plugins inspect myplugin
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.3.6/src/commands/plugins/inspect.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.
  -s, --silent   Silences yarn output.
  -v, --verbose  Show verbose yarn output.

GLOBAL FLAGS
  --json  Format output as json.

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
```

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

## `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
      --[no-]install  Install dependencies after linking the plugin.

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
```

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

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

Removes a plugin from the CLI.

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

EXAMPLES
  $ dream plugins remove myplugin
```

## `dream plugins reset`

Remove all user-installed and linked plugins.

```
USAGE
  $ dream plugins reset [--hard] [--reinstall]

FLAGS
  --hard       Delete node_modules and package manager related files in addition to uninstalling plugins.
  --reinstall  Reinstall all plugins after uninstalling.
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.3.6/src/commands/plugins/reset.ts)_

## `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

EXAMPLES
  $ dream plugins uninstall myplugin
```

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

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

Removes a plugin from the CLI.

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

EXAMPLES
  $ dream plugins unlink myplugin
```

## `dream plugins update`

Update installed plugins.

```
USAGE
  $ dream 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/v4.3.6/src/commands/plugins/update.ts)_

## `dream remove PACKAGE`

remove a package

```
USAGE
  $ dream remove PACKAGE

ARGUMENTS
  PACKAGE  package to remove

DESCRIPTION
  remove a package

EXAMPLES
  $ dream remove mongo
```

_See code: [src/commands/remove.ts](https://github.com/novodream/cli-poc/blob/v0.43.0/src/commands/remove.ts)_

## `dream run CMD`

Run arbitrary shell command with dream project env vars

```
USAGE
  $ dream run CMD... [-D] [-d] [-p] [-t] [-w <value>]

ARGUMENTS
  CMD...  command to run

FLAGS
  -D, --deploy             inject env vars for deploy for deploy packages. Require --terraform flag
  -d, --docker             run with docker run command
  -p, --package            inject env vars for package. Require --terraform flag
  -t, --terraform          run with terraform command
  -w, --workspace=<value>  workspace to run command in. Defaults to current workspace

DESCRIPTION
  Run arbitrary shell command with dream project env vars

EXAMPLES
  $ dream run npm run dev

  $ dream run --docker -- docker run -it -p 8080:8080 my-image
```

_See code: [src/commands/run.ts](https://github.com/novodream/cli-poc/blob/v0.43.0/src/commands/run.ts)_

## `dream set-env [NAME] [VALUE]`

Set environment variable for workspace

```
USAGE
  $ dream set-env [NAME] [VALUE] -w <value> [-f <value>] [-i] [-p <value>]

ARGUMENTS
  NAME   name of environment variable
  VALUE  value of environment variable

FLAGS
  -f, --from-json-file=<value>  JSON file to load environment variables from for bulk setting
  -i, --non-sensitive           set environment variable as not sensitive
  -p, --project=<value>         project to set environment variable for
  -w, --workspace=<value>       (required) workspace to set environment variable for

DESCRIPTION
  Set environment variable for workspace

EXAMPLES
  $ dream set-env -w dev MY_VAR my_secret_var

  $ dream set-env -w dev --non-sensitive KEY my_value

  $ dream set-env -w dev --from-json-file ./env.json

FLAG DESCRIPTIONS
  -f, --from-json-file=<value>  JSON file to load environment variables from for bulk setting

    The file should be a JSON object with keys representing environment variable names
    and values as objects with a 'value' key and optionally a 'sensitive' key.
    Example:
    {
    "MY_VAR": {
    "value": "my_secret_var",
    "sensitive": true
    },
    "KEY": {
    "value": "my_value"
    },
    "ANOTHER_VAR": {
    "value": "my_value",
    "sensitive": false
    }
    }
```

_See code: [src/commands/set-env.ts](https://github.com/novodream/cli-poc/blob/v0.43.0/src/commands/set-env.ts)_

## `dream set-private-key FILE`

Set rsa private key for workspace

```
USAGE
  $ dream set-private-key FILE -w <value>

ARGUMENTS
  FILE  file containing private key in pem format

FLAGS
  -w, --workspace=<value>  (required) workspace to set private key for

DESCRIPTION
  Set rsa private key for workspace

EXAMPLES
  $ dream set-private-key -w dev ./private.pem
```

_See code: [src/commands/set-private-key.ts](https://github.com/novodream/cli-poc/blob/v0.43.0/src/commands/set-private-key.ts)_

## `dream set-public-key FILE`

Set rsa public key for workspace

```
USAGE
  $ dream set-public-key FILE -w <value>

ARGUMENTS
  FILE  file containing public key in pem format

FLAGS
  -w, --workspace=<value>  (required) workspace to set public key for

DESCRIPTION
  Set rsa public key for workspace

EXAMPLES
  $ dream set-public-key -w dev ./public.pem
```

_See code: [src/commands/set-public-key.ts](https://github.com/novodream/cli-poc/blob/v0.43.0/src/commands/set-public-key.ts)_

## `dream up`

create all packages resources

```
USAGE
  $ dream up [-p] [-s <value>]

FLAGS
  -p, --production         exclude dev dependencies
  -s, --select=<value>...  [default: ] select a specific packages to provision

DESCRIPTION
  create all packages resources

EXAMPLES
  $ dream up
```

_See code: [src/commands/up.ts](https://github.com/novodream/cli-poc/blob/v0.43.0/src/commands/up.ts)_
<!-- commandsstop -->