Skip to content

Latest commit

 

History

History
121 lines (92 loc) · 3.5 KB

README.md

File metadata and controls

121 lines (92 loc) · 3.5 KB
Raw

rebar3_grisp_io

GitHub Release

Rebar plug-in for grisp.io. To obtain information about the plugin and its tasks, use the followinf command:

rebar3 help grisp-io [<task>]

📖 Table of content

Installation

To install the plugin globally, add it to your "plugins" list in ~/.config/rebar3/rebar.config

For example:

{plugins, [
    rebar3_hex,
    rebar3_grisp,
    rebar3_grisp_io
]}.

Afterwards to update it to the latest version, you need to update the Hex index and then the plugin:

rebar3 udpdate
rebar3 plugins upgrade rebar3_grisp_io

To verify that everything works correctly you can check the version of the plugin by calling:

rebar3 grisp-io version

Tasks

Authentication

This command allows you to authenticate on grisp.io and receive an API token.

The API token is encrypted and saved locally on your computer using the provided local password.

rebar3 grisp-io auth
===> Analyzing applications...
===> Compiling rebar3_grisp_io

Username > <Username>
Password > <Password>
Authentication successful - Please provide new local password
Local password > <LocalPassword>
Confirm your local password > <LocalPassword> % Must be the same
Token successfully requested

Deploy

Important

You need an authentication token to run this command see: authenticate You need an uploaded package on grisp.io as well see: upload

This command allows you to update a grisp board using a package uploaded previously on grisp.io

This command has 2 options (mandatory options are marked with ❗

  • --device or -d: This option specifies the serial number of the target device ❗
  • --package or -p: This option specifies the full package name that needs to be deployed

Note

📌 If no package name is specified, it will use the informations contained in your rebar.config to deduce the package name

Upload

Important

You need to authenticate first and request a token using authenticate

This command allows you to upload a package on grisp.io. Internally, this command will call rebar3 grisp pack and create a new release package. Release packages are identified by 3 elements:

  • The platform name (by default grisp2)
  • The application name
  • The release version in SemVer fashion (by default 0.1.0)

This command has 2 options:

  • --force or -f: This option will force an overwritting of the local and remote files of a given project and release
  • --no-pack or -p: With this option enabled, the command won't run internally the command rebar3 grisp pack

Validate

Important

You need to authenticate first and request a token using authenticate

This command allows you to validate an update that has been deployed on a device

This command has 1 mandatory option:

  • --device or -d: Used to specify the serial number of the device on which you want to validate the update
rebar3 grisp-io validate -d SERIAL_NUMBER

Version

rebar3 grisp-io version
===> Analyzing applications...
===> Compiling rebar3_grisp_io
rebar3_grisp_io: 0.1.0