| 1 | Noop CLI
|
| 2 | ========
|
| 3 | Interactive command line interface for Noop Platform and local development
|
| 4 |
|
| 5 | ## Requirements
|
| 6 | - node
|
| 7 | - git
|
| 8 | - docker
|
| 9 |
|
| 10 | ## Package Install
|
| 11 | `npm install -g @rearc/noop-cli`
|
| 12 |
|
| 13 | ## Local Install
|
| 14 | ```
|
| 15 | git clone git@github.com:rearc/noop-cli.git
|
| 16 | cd noop-cli
|
| 17 | npm install
|
| 18 | npm link
|
| 19 | ```
|
| 20 |
|
| 21 | ## Commands
|
| 22 | #### Run the app in local development mode which auto reloads
|
| 23 | `noop run [port] [-e componentname.ENV_KEY=Value] [--envFile .devEnv] [-e ENV_KEY=Value]`
|
| 24 |
|
| 25 | If a `.noopEnv` file exists in the root of the application, it will automatically be read.
|
| 26 |
|
| 27 | #### Analyze current project directory and display summary information
|
| 28 | `noop inspect`
|
| 29 |
|
| 30 | #### Reset state of a resource
|
| 31 | Resources run through the Noop Dev Server persist state between runs. To clear this state run:
|
| 32 | `noop reset <resourceName>` Example if your db resource state is corrupted because a bad version of the database was installed initially).
|
| 33 |
|
| 34 | #### Initialize a new project
|
| 35 | `noop init` (not implemented)
|
| 36 |
|
| 37 | Auto-detect what we can from the repo and then interact with user to provide additional detail.
|
| 38 |
|
| 39 | #### Create new a component
|
| 40 | `noop add component --type service --template nodejs --name ProductSite` (not implemented)
|
| 41 |
|
| 42 | Parameters
|
| 43 | - name? (do components have names?)
|
| 44 | - type (service, function, persistent?, static)
|
| 45 | - template
|
| 46 |
|
| 47 | #### Create a new resource for the current component
|
| 48 | `noop add resource --type mysql --name products` (not implemented)
|
| 49 |
|
| 50 | Parameters
|
| 51 | - name
|
| 52 | - type (mysql, dynamodb, s3)
|