halguru question
Get an answer to a question. Usage:
| 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. | |
--question-message, -q |
Message containing the question you want to ask the AI AgentConfiguration. | |
--files-pattern, -f |
Definition containing the questions to be passed to the AI AgentConfiguration. Example: //.txt | |
--exclude-pattern, -e |
/.*, /*.yaml | Exclude files that match this pattern. |
--output-file, -o |
If specified, the answer 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 a command to interact with the AI AgentConfiguration by posing questions and retrieving answers from the configured AI AgentConfiguration. The command can process direct questions or read question files for batched queries.
Remarks#
The QuestionCommand utilizes specified configurations, such as agent definitions and session data, to execute queries against an AI AgentConfiguration. It supports options for defining the agent, session, question input, and output behaviors.
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 written upon program exit.
When set to true, the session file used during the execution of the AI Robot will be updated or created upon exiting the application. This can be used to persist the current session state for future use.
Option --question-message, -q#
Message containing the question you want to ask the AI AgentConfiguration.
- Type:
String
Represents the text of the question to be asked to the AI AgentConfiguration.
This property allows a user to input a specific query intended for processing by the AI AgentConfiguration. It is optional and can be used as a direct alternative to providing questions via files.
Option --files-pattern, -f#
Definition containing the questions to be passed to the AI AgentConfiguration. Example: //.txt
- Type:
String[]
Represents a collection of file paths containing questions to be passed to the AI agent.
This property allows specifying multiple files with a pattern for the questions to be processed. It supports wildcard patterns, such as //.txt, to include multiple files. If not set, no additional question files are provided to the AI agent.
Option --exclude-pattern, -e#
Exclude files that match this pattern.
- Type:
String[] - Default:
System.String[]
Specifies patterns used to exclude files during processing.
These patterns define file paths to be ignored, typically using wildcards or specific patterns. Default values include commonly excluded file patterns.
Option --output-file, -o#
If specified, the answer will be written to the specified file.
- Type:
String
Specifies the file path where the answer generated by the AI will be written, if provided.
When set, the output of the AI's response will be saved to the specified file. If not specified, the response will not be written to a file.
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 |