Skip to content

halguru run

Start a conversation with the AI AgentConfiguration in interactive mode. Usage: 

halguru run [options]

Options Default Description
--help, -h Prints help information
--agent-file, -a The YAML file that defines the agent to be used.
--state-file, -s The session file to run AI Robot with.
--write-session-on-exit, -w If specified, the session file will be written on exit.
--output-file, -o If specified, the conversation will be written to the specified file.
--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.
--pre-release, -p If specified, pre-release environments will used to initialize secrets.
--verbose, -v Enables detailed output for debugging and troubleshooting purposes.

Summary#

Represents the command used to initiate a conversation with the AI AgentConfiguration in an interactive mode.

Option --help, -h#

Prints help information

Option --agent-file, -a#

The YAML file that defines the agent to be used.

  • Type: String

Represents the path to the YAML file that defines the configuration of the agent.

When the file name is not defined, it is searched for a file with the extension *.halguru in the current directory.

Option --state-file, -s#

The session file to run AI Robot with.

  • Type: String

Represents the file path to the session file used to run the AI AgentConfiguration.

This file contains session-specific data required for the AI AgentConfiguration to operate consistently. If not explicitly specified, the default value 'session.yaml' will be used.

Option --write-session-on-exit, -w#

If specified, the session file will be written on exit.

Indicates whether the session file should be saved upon the program's exit. When set to true, the current state of the session is written to the specified session file, allowing for persistence and continuity in subsequent runs. By default, the session is not written on exit.

Option --output-file, -o#

If specified, the conversation will be written to the specified file.

  • Type: String

Specifies the file path where the conversation will be written if provided. This optional setting allows outputting the conversation from a session to a designated file. When not specified, no conversation data will be saved.

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 --pre-release, -p#

If specified, pre-release environments will used to initialize secrets.

  • Type: 0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

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.

  • Type: 0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

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-12-05
Autogenerated: Yes
AI powered: Yes
Core version: 1.75.0