mix nerves_hub.product (nerves_hub_cli v0.11.1) View Source

Manages your products.

create

Create a new NervesHub product. The shell will prompt for information about the product. This information can be passed by specifying one or all of the command line options.

mix nerves_hub.product create

Command-line options

  • --name - (Optional) The product name

list

mix nerves_hub.product list

delete

mix nerves_hub.product delete [product_name]

update

Update product metadata.

Call list to retrieve product names and metadata keys

Examples

Change product name

mix nerves_hub.product update example name example_new

Managing user roles

The following functions allow the management of user roles within your product. Roles are a way of granting users a permission level so they may perform actions for your product. The following is a list of valid roles in order of highest role to lowest role:

  • admin
  • delete
  • write
  • read

NervesHub will validate all actions with your user role. If an action you are trying to perform requires write, the user performing the action will be required to have an org role of write or higher (admin, delete).

Managing user roles for your product will require that your user has the product role of admin.

user list

List the users and their role for the product.

mix nerves_hub.product user list PRODUCT_NAME

user add

Add an existing user to a product with a role.

mix nerves_hub.product user add PRODUCT_NAME USERNAME ROLE

user update

Update an existing user for your product with a new role.

mix nerves_hub.product user update PRODUCT_NAME USERNAME ROLE

user remove

Remove an existing user from having a role for your product.

mix nerves_hub.product user remove PRODUCT_NAME USERNAME

Link to this section Summary

Link to this section Functions

Link to this function

delete(org, product_name)

View Source

Specs

render_help() :: no_return()

Callback implementation for Mix.Task.run/1.

Link to this function

update(org, product, key, value)

View Source
Link to this function

user_add(org, product, username, role, auth \\ nil)

View Source
Link to this function

user_remove(org, product, username)

View Source
Link to this function

user_update(org, product, username, role)

View Source