commands - implementation
Prerequisites
- Have a Heex CLI
- Have a USER_SECRET_KEY. Should be accessible in your personnal space on the heex cloud platform.
Usage
Subcommand | Description |
---|---|
create | Create a new implementation on the cloud. |
create-template-file | Advanced usage: creates a template file for implementation creation configuration. |
Usage:
How to create a new implementation
2 different ways to create a new implementation on the cloud, both using the command create
:
- [Recommended]: create an implementation only by name and some optional description, using the 2 subcommands:
--name
: Must be unique on your cloud workspace.--description
: Description for your implementation.
Usage:
This will create the new implementaion on the Heex Cloud. You can later access this created implementation via the cloud platform and modify it there (i.e add signals).
- [Advanced]: Another way to create an implementation is to use a configuration file that contains all the data you want to generate. This is still a beta feature under progress, so it is not recommended, but if you want to use it:
- you can generate a template file using the
./heex implementation create-template-file
command, and then fill the given file as you need. - Once it is filled, use the create subcommand with the
--input-file
input pointing to the filled file.
- you can generate a template file using the
Usage:
⚠️ Warning:
implementation name or description with special characters If your implementation name or description contains special characters (i.e ’ or space), please use double quotes before and after your names.
For example, for a implementation called Jane’s implementation, provide that as —name “Jane’s implementation”.