Subcommand | Description |
---|---|
add-credentials | Add a system’s secret key to the credentials file. |
connectivity | Change the connectivity mode of a system. |
create | Create a new system on the cloud. |
create-template-file | Advanced usage: creates a template file for system creation configuration. |
get | Retrieve system details for a given ID. |
get-sys-conf | Retrieve system configuration for a given ID. |
list | List all systems. |
status | Provides the status of the system. |
todo-list | Provides systems todo list for a given workspace. |
update | Update a system on the cloud. |
delete | Delete a system with a given ID. |
--api-key
: The api secret key, it is required only if --system-key
is not defined.--system-key
: The system’s secret key, it is required only if --api-key
is not defined.--system-id
: The system id to fetch the secret key for, it is required only if --config-path
is not defined.--config-path
: The path to the system configuration file (.json
format), it is required only if --system-id
is not defined.--mode
.
create
:
--name
: Must be unique on your cloud workspace.--description
: Description for your system.--system-middleware
: System middleware. Check help for available middleware.--system-category
: System category. Check help for available templates../heex system create-template-file
command, and then fill the given file as you need.--input-file
input pointing to the filled filename
and type
are required, everything else can be removed.--input-file
and --system-id
which are both required. You can generate a template file using the command below:
Usage:
get
, which will retrieve system details for a given system ID in the specified output format. The system ID can be found on the web platform or by using command ./heex system list --api-key <USER_SECRET_KEY> [OPTIONAL-FILTERS]
. Flags available are:
--output-file
: Provide a path if you want system details to be saved in a file (add filename.json in your path).--system-id
: The id of the system to retrieve.⚠️ Warning: system name or description with special characters If your system name or description contains special characters (i.e ’ or space), please use double quotes before and after your names.For example, for a system called Jane’s system, provide that as —name “Jane’s system”.
get-sys-conf
, which will retrieve system configuration for a given system ID in the specified output format. Options are the same as get
command. See the usage example below:
Usage:
status
. This command will retrieve the status of a given system ID in the specified output format.
Information that will be provided is:
todo-list
. You can filter the result by providing a system ID and/or system status. If a system status is given, for example , --system-status TO_CODE
, only systems with the given status will be returned and you’ll be able to see the list of systems that need to be coded yet.
Available flags are:
--api-key
: The api secret key: USER_SECRET_KEY.--system-id
: The id of the system to retrieve.--system-status
: The status of the system to retrieve. Check help for available status.--details
: Show details of each system implementations status included.--output-file
: Provide a path if you want the output to be saved in a file.--details
is provided, the output will be a list of systems including their signal details. Otherwise, it will display only system id, status and agent version when available.
Usage:
list
. Same as for todo-list
, you can filter the result by providing a system ID and/or system status. The result will be a list of systems with details.
Available flags are:
--api-key
: The api secret key: USER_SECRET_KEY.--system-id
: The id of the system to retrieve.--system-status
: The status of the system to retrieve. Check help for available status.--output-file
: Provide a path if you want the output to be saved in a file.system-id
and use the command below:
Usage: