halguru platform download
Download the AI agent from the hal.guru platform. Usage:
| Options | Default | Description |
|---|---|---|
--help, -h |
Prints help information | |
--api-key, -k |
The API key to use for the hal.guru platform. | |
--api-url, -u |
If specified, the API URL to use for hal.guru platform. | |
--agent-id, -i |
If specified, only active agents will be checked. | |
--out-agent-file, -f |
The file name to use for the downloaded agent. | |
--overwrite, -o |
Overwrite file if already exists? | |
--pre-release, -p |
If specified, pre-release environments will be included in the download. | |
--verbose, -v |
Enables detailed output for debugging and troubleshooting purposes. |
Summary#
Represents a command to download AI agents from the hal.guru platform.
Remarks#
This command interacts with the hal.guru platform to retrieve and save an AI agent locally based on the specified settings. It provides options for API configuration, agent identification, output file details, and verbosity.
Option --help, -h#
Prints help information
Option --api-key, -k#
The API key to use for the hal.guru platform.
- Type:
String
The API key used for authenticating requests to the hal.guru platform.
This property allows the user to specify the API key required for connecting to the hal.guru platform. It should be provided if authentication is needed to access platform services or perform API operations. If not provided, the environment variable 'HalGuruApiKey' will be used.
Option --api-url, -u#
If specified, the API URL to use for hal.guru platform.
- Type:
String
Represents the API URL used for publishing the agent. This property specifies the endpoint to which the agent data will be sent. If not provided, the default URL configuration is used.
If not provided, the environment variable 'HalGuruApiUrl' will be used. Otherwise, the default URL https://api.hal.guru will be used.
Option --agent-id, -i#
If specified, only active agents will be checked.
- Type:
Guid
Gets or sets the unique identifier for the AI agent to be acted upon.
This property specifies the Agent ID required to interact with a specific AI agent on the hal.guru platform. It is used to identify the agent for actions such as downloading and other operations. Providing this value is mandatory to ensure that the command targets the correct agent.
Option --out-agent-file, -f#
The file name to use for the downloaded agent.
- Type:
String
Specifies the file name to save the downloaded agent to.
This property indicates the name of the output file where the data for the downloaded agent will be stored. If not specified, a default file name may be generated by the system. Ensure that the file name does not conflict with existing files unless overwriting is enabled.
Option --overwrite, -o#
Overwrite file if already exists?
Gets or sets a value indicating whether to overwrite the file if it already exists during the download process.
This property determines the behavior when a file with the same name as the specified output file already exists. If set to true, the existing file will be overwritten. If set to false, the command will prevent overwriting, potentially resulting in an error or skipping the operation based on the implementation.
Option --pre-release, -p#
If specified, pre-release environments will be included in the download.
Indicates whether the platform check should include pre-release environments.
This property determines if pre-release versions of the platform should be considered during the execution of the platform check. When set to true, the operation will include pre-release environments for validation and status assessment. It is useful for testing or verifying changes in a staging or beta environment prior to a production release.
Option --verbose, -v#
Enables detailed output for debugging and troubleshooting purposes.
Specifies whether detailed output is enabled for debugging and troubleshooting purposes.
When set to true, additional information about the command execution process is displayed, which can be useful for diagnosing issues or understanding internal operations. By default, the value is false, indicating standard output only.
| Last updated: | 2025-10-13 | |
| Autogenerated: | Yes | |
| AI powered: | Yes | |
| Core version: | 1.66.0 |