CLI Commands

The following commands are available in the halguru command-line application:

▷ about#

Information about the program. Details

Usage:

halguru about [options]

Options	Default	Description
`--help`, `-h`		Prints help information
`--system`, `-s`		Display the information aboutExecutor the system.
`--license`, `-l`		Display the license information.
`--verbose`, `-v`		Enables detailed output for debugging and troubleshooting purposes.

▷ create#

Create a new AI AgentConfiguration from a template. Details

Usage:

halguru create [options]

Options	Default	Description
`--help`, `-h`		Prints help information
`--agent-file`, `-a`	agent.halguru.yaml	The YAML file defining the agent to be built.
`--template`, `-t`	OpenAIAssistant	The template to use for the agent.
`--overwrite`, `-o`		Specifies whether to overwrite the existing agent configuration file.
`--add-comments`, `-c`		Adds comments to the YAML file during configuration.
`--expanded-yaml`, `-e`		Extends the YAML file with properties that are null.
`--verbose`, `-v`		Enables detailed output for debugging and troubleshooting purposes.

▷ build#

Build an AI AgentConfiguration from a YAML file. Details

Usage:

halguru build [options]

Options	Default	Description
`--help`, `-h`		Prints help information
`--agent-file`, `-a`		The YAML file defining the agent to be built.
`--verbose`, `-v`		Enables detailed output for debugging and troubleshooting purposes.

▷ test#

Execute tests for the AI agent. Details

Usage:

halguru test [options]

Options	Default	Description
`--help`, `-h`		Prints help information
`--agent-file`, `-a`		The YAML file that defines the agent to be used.
`--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.

▷ configure#

Publish an AI AgentConfiguration to the hal.guru platform. Details

Usage:

halguru configure [options]

Options	Default	Description
`--help`, `-h`		Prints help information
`--agent-file`, `-a`		The YAML file that defines the agent to be used.
`--add-comments`, `-c`		Adds comments to the YAML file during configuration.
`--remove-comments`, `-r`		Removes comments from the YAML file during configuration.
`--expanded-yaml`, `-e`		Extends the YAML file with properties that are null.
`--force`, `-f`		Forces the configuration process to proceed without prompting for confirmation.
`--pre-release`, `-p`		If specified, pre-release environments will be included in the configuration.
`--export-as-json`, `-j`		If specified, the configuration will be exported as JSON.
`--export-as-xml`, `-x`		If specified, the configuration will be exported as XML.
`--verbose`, `-v`		Enables detailed output for debugging and troubleshooting purposes.

▷ question#

Get an answer to a question. Details

Usage:

halguru question [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.
`--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.

▷ run#

Start a conversation with the AI AgentConfiguration in interactive mode. Details

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.

▷ manual#

Displays and generates the manual for the halguru program. Details

Usage:

halguru manual [options]

Options	Default	Description
`--help`, `-h`		Prints help information
`--error-codes`, `-e`		Enables detailed output for debugging and troubleshooting purposes.
`--display-manual`, `-d`		Display the manual.
`--generate-file`, `-g`		Generate the Markdown manual file.
`--generate-schemas`, `-s`		Generate JSON schemas for the models into the specified directory.
`--generate-yaml-docs`, `-y`		Generate documentation for the hal.guru models.
`--generate-cli-docs`, `-c`		Generate documentation for the CLI commands.
`--generate-version-file`, `-r`		Generate a version file.
`--overwrite`, `-o`		Overwrite an existing manual file.
`--verbose`, `-v`		Enables detailed output for debugging and troubleshooting purposes.

▷ install#

Installs the halguru CLI program in the current environment. Details

Usage:

halguru install [options]

Options	Default	Description
`--help`, `-h`		Prints help information
`--use-remote-schemas`, `-u`		Use remote schemas from the https://docs.hal.guru/schemas/ directory.
`--force`, `-f`		Force installation
`--verbose`, `-v`		Enables detailed output for debugging and troubleshooting purposes.

▷ update#

Updates the halguru CLI program in the current environment. Details

Usage:

halguru update [options]

Options	Default	Description
`--help`, `-h`		Prints help information
`--pre-release`, `-p`		Specifies whether to include prerelease versions in the update process.
`--verbose`, `-v`		Enables detailed output for debugging and troubleshooting purposes.

▷ webscraping#

Scrape a website and save the content to a file. Details

Usage:

halguru webscraping [options]

Options	Default	Description
`--help`, `-h`		Prints help information
`--webscraping-configuration-file`, `-w`		The YAML file defining the web scraping configuration.
`--output-file`, `-f`	files/webscraping.xml	The output website data file.
`--overwrite`, `-o`		Overwrite file if already exists?
`--verbose`, `-v`		Enables detailed output for debugging and troubleshooting purposes.

▷ platform status#

Check the status of the hal.guru platform. Details

Usage:

halguru platform status [options]

Options	Default	Description
`--help`, `-h`		Prints help information
`--api-url`, `-u`		If specified, the API URL to use for hal.guru platform.
`--pre-release`, `-p`		If specified, pre-release environments will be included in the status check.
`--verbose`, `-v`		Enables detailed output for debugging and troubleshooting purposes.

▷ platform publish#

Publish an AI AgentConfiguration to the hal.guru platform. Details

Usage:

halguru platform publish [options]

Options	Default	Description
`--help`, `-h`		Prints help information
`--agent-file`, `-a`		The YAML file defining the agent to be built.
`--api-key`, `-k`		The API key to use for publishing the agent.
`--api-url`, `-u`		If specified, the API URL to use for publishing the agent.
`--pre-release`, `-p`		If specified, pre-release environments will be included in the publishing.
`--verbose`, `-v`		Enables detailed output for debugging and troubleshooting purposes.

▷ platform list#

List AI agents on the hal.guru platform. Details

Usage:

halguru platform list [options]

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.
`--pre-release`, `-p`		If specified, pre-release environments will be included in the list.
`--list-only-active`, `-a`		If specified, only active platforms are listed.
`--verbose`, `-v`		Enables detailed output for debugging and troubleshooting purposes.

▷ platform download#

Download the AI agent from the hal.guru platform. Details

Usage:

halguru platform download [options]

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.
`--export-as-json`, `-j`		If specified, the configuration will be exported as JSON.
`--export-as-xml`, `-x`		If specified, the configuration will be exported as XML.
`--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.

▷ platform check#

Check AI agents published on the Hal.guru platform. Details

Usage:

halguru platform check [options]

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.
`--check-only-active`, `-a`		If specified, only active agents will be checked.
`--pre-release`, `-p`		If specified, pre-release environments will be included in the check.
`--verbose`, `-v`		Enables detailed output for debugging and troubleshooting purposes.

▷ rag upload#

Upload files to the RAG. Details

Usage:

halguru rag upload [options]

Options	Default	Description
`--help`, `-h`		Prints help information
`--agent-file`, `-a`		The YAML file that defines the agent to be used.
`--llm-connector`, `-l`		LLM Connector name to use. If not set, uses the first one.
`--files-pattern`, `-f`	files/*/	The files to upload pattern. Use * for all files from the current folder.
`--exclude-pattern`, `-e`	*/.,** /*.yaml	Exclude files that match this pattern.
`--verbose`, `-v`		Enables detailed output for debugging and troubleshooting purposes.

▷ rag download#

Download file from the RAG. Details

Usage:

halguru rag download [options]

Options	Default	Description
`--help`, `-h`		Prints help information
`--agent-file`, `-a`		The YAML file that defines the agent to be used.
`--llm-connector`, `-l`		LLM Connector name to use. If not set, uses the first one.
`--files-pattern`, `-f`	files/*/	The pattern of files to download from the LLM. Use * to match all files in the current folder.
`--exclude-pattern`, `-e`	*/.,** /*.yaml	Exclude files that match this pattern.
`--overwrite`, `-o`		Overwrite file if already exists?
`--verbose`, `-v`		Enables detailed output for debugging and troubleshooting purposes.

▷ rag delete#

Delete a file from the RAG. Details

Usage:

halguru rag delete [options]

Options	Default	Description
`--help`, `-h`		Prints help information
`--agent-file`, `-a`		The YAML file that defines the agent to be used.
`--llm-connector`, `-l`		LLM Connector name to use. If not set, uses the first one.
`--files-pattern`, `-f`	files/*/	The pattern of files to delete from the LLM. Use * to match all files in the current folder.
`--exclude-pattern`, `-e`	*/.,** /*.yaml	Exclude files that match this pattern.
`--verbose`, `-v`		Enables detailed output for debugging and troubleshooting purposes.

▷ rag list#

List files stored by the RAG. Details

Usage:

halguru rag list [options]

Options	Default	Description
`--help`, `-h`		Prints help information
`--agent-file`, `-a`		The YAML file that defines the agent to be used.
`--llm-connector`, `-l`		LLM Connector name to use. If not set, uses the first one.
`--verbose`, `-v`		Enables detailed output for debugging and troubleshooting purposes.

▷ rag clear#

Remove all files from the RAG. Details

Usage:

halguru rag clear [options]

Options	Default	Description
`--help`, `-h`		Prints help information
`--agent-file`, `-a`		The YAML file that defines the agent to be used.
`--llm-connector`, `-l`		LLM Connector name to use. If not set, uses the first one.
`--verbose`, `-v`		Enables detailed output for debugging and troubleshooting purposes.

▷ rag list#

List available templates. Details

Usage:

halguru rag list [options]

Options	Default	Description
`--help`, `-h`		Prints help information
`--details`, `-d`		Show details of the templates.
`--verbose`, `-v`		Enables detailed output for debugging and troubleshooting purposes.

Last updated:		2025-12-05
Autogenerated:		Yes
AI powered:		Yes
Core version:		1.75.0