Job
The bacalhau job command provides a suite of sub-commands to submit, query, and manage jobs within Bacalhau. Users can deploy jobs, obtain job details, track execution logs, and more.
Usage
bacalhau job [command]
Available Commands
-
-
Description: Retrieves detailed information of a job using its ID.
-
Usage:
bacalhau job describe
-
-
-
Description: Lists all executions associated with a job, identified by its ID.
-
Usage:
bacalhau job executions
-
-
get:
-
Description: Get the results of a job, identified by its ID.
-
Usage:
bacalhau job get
-
-
-
Description: Enumerates the historical events related to a job, identified by its ID.
-
Usage:
bacalhau job history
-
-
list:
-
Description: Provides an overview of all submitted jobs.
-
Usage:
bacalhau job list
-
-
logs:
-
Description: Fetches and streams the logs from a currently executing job.
-
Usage:
bacalhau job logs
-
-
run:
-
Description: Submits a job for execution using either a JSON or YAML configuration file.
-
Usage:
bacalhau job run
-
-
stop:
-
Description: Halts a previously submitted job.
-
Usage:
bacalhau job stop
-
For comprehensive details on any of the sub-commands, run:
bacalhau job [command] --help
Flags
-h,--help:- Description: Shows the help information for the
jobcommand.
- Description: Shows the help information for the
Global Flags
--api-host string:- Description: Determines the host for RESTful communication between the client and server. This flag is overlooked if the
BACALHAU_API_HOSTenvironment variable is set. - Default:
bootstrap.production.bacalhau.org
- Description: Determines the host for RESTful communication between the client and server. This flag is overlooked if the
--api-port int:- Description: Designates the port for RESTful communication. This flag is bypassed if the
BACALHAU_API_PORTenvironment variable is active. - Default:
1234
- Description: Designates the port for RESTful communication. This flag is bypassed if the
--log-mode logging-mode:- Description: Chooses the preferred log format. Available choices are:
default,station,json,combined, andevent. - Default:
default
- Description: Chooses the preferred log format. Available choices are:
--repo string:- Description: Specifies the path to the bacalhau repository.
- Default:
$HOME/.bacalhau