The bacalhau agent alive command provides information about the agent's liveness and health. This is essential for monitoring and ensuring that the agent is active and functioning correctly.
-h, --help:
Description: Displays help information for the alive sub-command.
--output format:
Description: Determines the format in which the output is displayed. Available formats include JSON and YAML.
Options: json, yaml
Default: yaml
--pretty:
Description: Formats the output for enhanced readability. This flag is relevant only when using JSON or YAML output formats.
--api-host string:
Description: Specifies the host used for RESTful communication between the client and server. The flag is disregarded if the BACALHAU_API_HOST environment variable is set.
Default: bootstrap.production.bacalhau.org
--api-port int:
Description: Specifies the port for REST communication. If the BACALHAU_API_PORT environment variable is set, this flag will be ignored.
Default: 1234
--log-mode logging-mode:
Description: Sets the desired log format. Options are: default, station, json, combined, and event.
Default: default
--repo string:
Description: Defines the path to the bacalhau repository.
Default: ``$HOME/.bacalhau`
Basic Usage:
Command:
Output:
Output in JSON format:
Command:
Output:
The bacalhau agent node command retrieves information about the agent's node, providing insights into the agent's environment and aiding in debugging.
-h, --help:
Displays help information for the node sub-command.
--output format:
Defines the output format (either JSON or YAML).
Options: json, yaml
Default: yaml
--pretty:
Beautifies the output when using JSON or YAML formats.
--api-host string:
The host for REST communication. Overrides the BACALHAU_API_HOST environment variable.
Default: bootstrap.production.bacalhau.org
--api-port int:
The port for REST communication. Overridden if BACALHAU_API_PORT environment variable is set.
Default: 1234
--log-mode logging-mode:
Specifies the log format. Choices are: default, station, json, combined, event.
Default: default
--repo string:
Path to the bacalhau repository.
Default: ``$HOME/.bacalhau`
Retrieve Node Information in Default Format (YAML)
Retrieve Node Information in JSON Format
Retrieve Node Information in Pretty-printed JSON Format
The bacalhau agent command is a parent command that offers sub-commands to query information about the Bacalhau agent. This can be useful for debugging, monitoring, or managing the agent's behavior and health.
:
Description: Retrieves the agent's liveness and health information. This can be helpful to determine if the agent is running and healthy.
Usage:
:
Description: Gathers the agent's node-related information. This might include details about the machine or environment where the agent is running, available resources, supported engines, etc.
Usage:
:
Description: Retrieves the Bacalhau version of the agent. This can be beneficial for ensuring compatibility or checking for updates.
Usage:
For more detailed information on any of the sub-commands, you can use the command:
-h, --help:
Description: Displays help information for the agent command.
--api-host string:
Description: Specifies the host used for RESTful communication between the client and server. The flag is disregarded if the BACALHAU_API_HOST environment variable is set.
Default: bootstrap.production.bacalhau.org
--api-port int:
Description: Specifies the port for REST communication. If the BACALHAU_API_PORT environment variable is set, this flag will be ignored.
Default: 1234
--log-mode logging-mode:
Description: Sets the desired log format. Options are: default, station, json, combined, and event.
Default: default
--repo string:
Description: Defines the path to the bacalhau repository.
Default: ``$HOME/.bacalhau`
The bacalhau agent version command is used to obtain the version of the bacalhau agent.
Using this command, users can quickly retrieve the version of the agent, allowing them to confirm the specific release of the software they are using.
-h, --help:
Show help for the version command.
--output format:
Defines the output format of the command's results. Accepted formats include "json" and "yaml".
--pretty:
Used for pretty printing the output, enhancing readability. This flag is applicable only for the "json" and "yaml" output formats.
--api-host string:
Designates the host for client-server communication via REST. If the BACALHAU_API_HOST environment variable is present, this flag will be disregarded.
Default: "bootstrap.production.bacalhau.org"
--api-port int:
Defines the port for client-server communication through REST. This flag becomes irrelevant if the BACALHAU_API_PORT environment variable is specified.
Default: 1234
--log-mode logging-mode:
Specifies the desired logging format.
Options: 'default','station','json','combined','event'
Default: 'default'
--repo string:
Indicates the path to the bacalhau repository.
Default: "$HOME/.bacalhau"`
Retrieve the agent version:
Execute the command to get the agent version:
Expected output:
Retrieve the agent version in JSON format:
Expected output:
Retrieve the agent version in Pretty-printed JSON format:
Expected output: