slana.yml

name: chunky
footer:
  suffix: "Chunky says:"
  text: "enjoy and check out more info at http://chunky.io"
commands:
- name: init [name]
  more: Specify a custom name or go with the default generated name
  description: Create a new product
  executor: executors/init
  options:
  - name: template
    description: The product template to use
    default: default
    type: string
  examples:
  - command: init MyProduct
    description: Create a new product using the default template
  - command: init MyProduct --template some-template
    description: Create a new product using the specified template

- name: install
  more: Install all dependencies, if any are required
  description: Install all product dependencies
  executor: executors/install
  options:
  - name: verbose
    description: Print installation details
    default: false
    type: boolean
  examples:
  - command: install
    description: Install all the dependencies

- name: start [platforms..]
  description: Start the packagers for one or more platforms
  more: The supported platforms are web and mobile
  executor: executors/start
  options:
  - name: mobile-packager-port
    description: Use a custom mobile packager port
    type: string
    default: 8081
  - name: web-packager-port
    description: Use a custom web packager port
    default: 8082
    type: string
  examples:
  - command: start
    description: Start all the packagers, using the default ports
  - command: start web mobile
    description: Start the web and mobile packagers, using the default ports
  - command: start mobile
    description: Start the mobile packager only, using the default mobile port
  - command: start web
    description: Start the web packager only, using the default web port
  - command: start --mobile-port 9200
    description: Start all the packagers, using the default web port and a custom mobile port
  - command: start mobile --mobile-port 9200
    description: Start the mobile packager only, using a custom mobile port

- name: run [platforms..]
  description: Run the product on one or more platforms
  more: The supported platforms are ios, android, web
  executor: executors/run
  options:
  - name: release
    description: Run the release package
    default: false
    type: boolean
  - name: web-port
    description: Use a custom web app port
    default: 8082
    type: string
  examples:
  - command: run
    description: Run the product on all the platforms
  - command: run ios
    description: Run the iOS app only
  - command: run android
    description: Run the Android app only
  - command: run web
    description: Run the Web app only
  - command: run site
    description: Run the Site only

- name: report [reports..]
  description: Run cloud reports
  more: Specify one or more reports or blank to apply all
  executor: executors/report
  options:
  - name: env
    description: The cloud environment to be used for reporting
    type: string
    default: dev
  - name: chunks
    description: One or more chunks to search for reports
    type: array
  examples:
  - command: report
    description: Run all reports from all chunks on the default dev cloud environment
  - command: report --env staging
    description: Run all reported from all chunks on the staging cloud environment

- name: transform [transforms..]
  description: Apply cloud transforms
  more: Specify one or more transforms or blank to apply all
  executor: executors/transform
  options:
  - name: env
    description: The cloud environment to be transformed
    type: string
    default: dev
  - name: chunks
    description: One or more chunks to search for transforms
    type: array
  examples:
  - command: transform
    description: Apply all transforms from all chunks to the default dev cloud environment
  - command: transform --env staging
    description: Apply all transforms from all chunks to the staging cloud environment
  - command: transform posts --env production
    description: Apply only the posts transform if any, from each chunk to the production cloud environment
  - command: transform --chunks feed
    description: Apply all the transform from the feed chunk to the default dev cloud environment
  - command: transform posts --chunks feed
    description: Apply only the posts transform from the feed chunk to the default dev cloud environment
  - command: transform posts comments --chunks feed
    description: Apply only the posts and comments transforms from the feed chunk to the default dev cloud environment
  - command: transform messages --chunks friends inbox
    description: Apply only the messages transform from the friends and inbox chunks to the default dev cloud environment

- name: reset [layers..]
  description: Reset one or more layers of the cloud
  more: The supported layers are users and data
  executor: executors/reset
  options:
  - name: env
    description: The cloud environment to be reset
    default: dev
    type: string
  examples:
  - command: reset
    description: Reset all the layers of default dev cloud environment
  - command: reset --env staging
    description: Reset all the layers of staging cloud environment
  - command: reset users
    description: Reset only the users in the default dev cloud environment
  - command: reset users data --env production
    description: Reset the users and the data in the production cloud environment

- name: add [artifacts..]
  description: Add one or more local artifact
  more: The supported artifacts are chunk and function
  executor: executors/add
  options:
  - name: name
    description: The name of the new artifact
    default: artifact
    type: string
  - name: template
    description: The template to create the artifact from
    default: default
    type: string
  examples:
  - command: add chunk --name friends
    description: Add a new chunk named "friends"
  - command: add function --name friends/invite
    description: Add an "invite" function in the "friends" chunk

- name: deploy [artifacts..]
  description: Deploy one or more product artifacts to the cloud
  more: The supported artifacts are functions and assets
  executor: executors/deploy
  options:
  - name: env
    description: The cloud environment where to deploy
    default: dev
    type: string
  - name: chunks
    description: One or more chunks to search for artifacts
    type: array
  - name: remove
    description: Remove the previously artifacts from the cloud
    type: boolean
  examples:
  - command: deploy
    description: Deploy all artifacts from all chunks to the default dev cloud environment
  - command: deploy --env staging
    description: Deploy all artifacts from all chunks to the staging cloud environment
  - command: deploy functions
    description: Deploy only the cloud functions from all chunks to the default dev cloud environment
  - command: deploy assets
    description: Deploy only the assets from all chunks to the default dev cloud environment
  - command: deploy functions assets --env production
    description: Deploy the cloud functions and assets from all chunks to the production cloud environment
  - command: deploy functions --chunks friends inbox
    description: Deploy only the cloud functions from the friends and inbox chunks to the default dev cloud environment
  - command: deploy functions --chunks auth --env production
    description: Deploy only the cloud functions from the auth chunk to the production cloud environment
  - command: deploy functions --remove
    description: Remove all the previously deployed functions from the default dev cloud environment

- name: package [platforms..]
  description: Package the product for one or more platforms
  more: The supported platforms are ios, android, web and site
  executor: executors/package
  options:
  - name: optimize
    description: Optimize the package
    default: false
    type: boolean
  examples:
  - command: package
    description: Package the product for all the platforms
  - command: package ios
    description: Package the iOS app only
  - command: package site android --optimize
    description: Package the site and the Android app and optimize then