Notation CLI

The CLI is included in the @notation/cli package, which is installed as part of the starter kit.

Typically, commands are run from package.json scripts:

{
  "scripts": {
    "deploy": "notation compile <stackEntryPoint>",
    "dashboard": "notation dashboard",
    "deploy": "notation deploy <stackEntryPoint>",
    "destroy": "notation deploy <stackEntryPoint>",
    "watch": "notation deploy <stackEntryPoint>",
    "viz": "notation deploy <stackEntryPoint>"
  }
}

npm run deploy # etc

Commands

compile

notation compile <stackEntryPoint>

Compiles runtime and infra modules to /dist.

dashboard

notation dashboard

Starts a dashboard server for observing the state of the deployment.

deploy

notation deploy <stackEntryPoint>

Compiles and deploys the stack.

destroy

notation destroy <stackEntryPoint>

Removes all resources associated with the stack.

viz

notation viz <stackEntryPoint>

Produces a graph of the stack's resources.

watch

notation watch <stackEntryPoint>

Watches for changes to the stack and automatically redeploys the application.