bacalhau-project · ChrisChinchilla · Jun 3, 2025 · Jun 4, 2025
diff --git a/docs/cli/agent/README.md → docs/cli/agent/README.mdx b/docs/cli/agent/README.md → docs/cli/agent/README.mdx
@@ -1,3 +1,5 @@
+import GlobalFlags from './_agent-global-flags.md';
+
 # Agent
 
 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.
@@ -10,7 +12,7 @@ bacalhau agent [command]
 
 ## Available Commands
 
-1. [**alive**](alive.md):
+1. [**alive**](alive.mdx):
 
    - Description: Retrieves the agent's liveness and health information. This can be helpful to determine if the agent is running and healthy.
    - Usage:
@@ -19,7 +21,7 @@ bacalhau agent [command]
      bacalhau agent alive
      ```
 
-2. [**node**](node.md):
+2. [**node**](node.mdx):
 
    - 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:
@@ -28,7 +30,7 @@ bacalhau agent [command]
      bacalhau agent node
      ```
 
-3. [**version**](version.md):
+3. [**version**](version.mdx):
 
    - Description: Retrieves the Bacalhau version of the agent. This can be beneficial for ensuring compatibility or checking for updates.
    - Usage:
@@ -48,17 +50,4 @@ bacalhau agent [command] --help
 - `-h`, `--help`:
   - Description: Displays help information for the `agent` command.
 
-## Global Flags
-
-- `--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\`
+<GlobalFlags />
diff --git a/docs/cli/agent/_agent-global-flags.md b/docs/cli/agent/_agent-global-flags.md
@@ -0,0 +1,14 @@
+## Global Flags
+
+- `--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\`
diff --git a/docs/cli/agent/alive.md → docs/cli/agent/alive.mdx b/docs/cli/agent/alive.md → docs/cli/agent/alive.mdx
@@ -1,3 +1,5 @@
+import GlobalFlags from './_agent-global-flags.md';
+
 # Alive
 
 ## Description
@@ -21,20 +23,7 @@ bacalhau agent alive [flags]
 - `--pretty`:
   - Description: Formats the output for enhanced readability. This flag is relevant only when using JSON or YAML output formats.
 
-## Global Flags
-
-- `--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\`
+<GlobalFlags />
 
 ## Examples
 

diff --git a/docs/cli/agent/node.md → docs/cli/agent/node.mdx b/docs/cli/agent/node.md → docs/cli/agent/node.mdx
@@ -1,3 +1,5 @@
+import GlobalFlags from './_agent-global-flags.md';
+
 # Node
 
 ## Description
@@ -21,20 +23,7 @@ bacalhau agent node [flags]
 - `--pretty`:
   - Beautifies the output when using JSON or YAML formats.
 
-## Global Flags
-
-- `--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\`
+<GlobalFlags />
 
 ## Examples
 

diff --git a/docs/cli/agent/version.md → docs/cli/agent/version.mdx b/docs/cli/agent/version.md → docs/cli/agent/version.mdx
@@ -1,3 +1,5 @@
+import GlobalFlags from './_agent-global-flags.md';
+
 # Version
 
 The `bacalhau agent version` command is used to obtain the version of the bacalhau agent.
@@ -21,21 +23,7 @@ bacalhau agent version [flags]
 - **`--pretty`**:
   - Used for pretty printing the output, enhancing readability. This flag is applicable only for the "json" and "yaml" output formats.
 
-## Global Flags:
-
-- **`--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"\`
+<GlobalFlags />
 
 ## Examples
 

diff --git a/docs/cli/job/README.md → docs/cli/job/README.mdx b/docs/cli/job/README.md → docs/cli/job/README.mdx
@@ -1,3 +1,5 @@
+import GlobalFlags from './_job-global-flags.md';
+
 # 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.
@@ -10,7 +12,7 @@ bacalhau job [command]
 
 ## Available Commands
 
-1. [**describe**](./describe.md):
+1. [**describe**](./describe.mdx):
 
    - Description: Retrieves detailed information of a job using its ID.
    - Usage:
@@ -19,7 +21,7 @@ bacalhau job [command]
      bacalhau job describe
      ```
 
-2. [**executions**](./executions.md):
+2. [**executions**](./executions.mdx):
 
    - Description: Lists all executions associated with a job, identified by its ID.
    - Usage:
@@ -28,7 +30,7 @@ bacalhau job [command]
      bacalhau job executions
      ```
 
-3. [**get**](./get.md):
+3. [**get**](./get.mdx):
 
    - Description: Get the results of a job, identified by its ID.
    - Usage:
@@ -37,15 +39,16 @@ bacalhau job [command]
      bacalhau job get
      ```
 
-4. [**history**](./history.md):
+4. [**history**](./history.mdx):
 
    - Description: Enumerates the historical events related to a job, identified by its ID.
    - Usage:
 
      ```bash
      bacalhau job history
      ```
-5. [**list**](./list.md):
+
+5. [**list**](./list.mdx):
 
    - Description: Provides an overview of all submitted jobs.
    - Usage:
@@ -54,7 +57,7 @@ bacalhau job [command]
      bacalhau job list
      ```
 
-6. [**logs**](./logs.md):
+6. [**logs**](./logs.mdx):
 
    - Description: Fetches and streams the logs from a currently executing job.
    - Usage:
@@ -63,7 +66,7 @@ bacalhau job [command]
      bacalhau job logs
      ```
 
-7. [**run**](./run.md):
+7. [**run**](./run.mdx):
 
    - Description: Submits a job for execution using either a JSON or YAML configuration file.
    - Usage:
@@ -72,7 +75,7 @@ bacalhau job [command]
      bacalhau job run
      ```
 
-8. [**stop**](./stop.md):
+8. [**stop**](./stop.mdx):
 
    - Description: Halts a previously submitted job.
    - Usage:
@@ -92,17 +95,4 @@ bacalhau job [command] --help
 - `-h`, `--help`:
   - Description: Shows the help information for the `job` command.
 
-## Global Flags
-
-1. `--api-host string`:
-   - Description: Determines the host for RESTful communication between the client and server. This flag is overlooked if the `BACALHAU_API_HOST` environment variable is set.
-   - Default: `bootstrap.production.bacalhau.org`
-2. `--api-port int`:
-   - Description: Designates the port for RESTful communication. This flag is bypassed if the `BACALHAU_API_PORT` environment variable is active.
-   - Default: `1234`
-3. `--log-mode logging-mode`:
-   - Description: Chooses the preferred log format. Available choices are: `default`, `station`, `json`, `combined`, and `event`.
-   - Default: `default`
-4. `--repo string`:
-   - Description: Specifies the path to the bacalhau repository.
-   - Default: `$HOME/.bacalhau`
+<GlobalFlags />
diff --git a/docs/cli/job/_job-global-flags.md b/docs/cli/job/_job-global-flags.md
@@ -0,0 +1,14 @@
+## Global Flags
+
+- `--api-host string`:
+  - Description: Specifies the host for the client and server to communicate through via REST. If the `BACALHAU_API_HOST` environment variable is set, this flag will be ignored.
+  - Default: `bootstrap.production.bacalhau.org`
+- `--api-port int`:
+  - Description: Determines the port for the client and server to communicate on using REST. If the `BACALHAU_API_PORT` environment variable is set, this flag will be ignored.
+  - Default: `1234`
+- `--log-mode logging-mode`:
+  - Description: Specifies the desired log format. Supported values include `default`, `station`, `json`, `combined`, and `event`.
+  - Default: `default`
+- `--repo string`:
+  - Description: Defines the path to the bacalhau repository.
+  - Default: `$HOME/.bacalhau`
diff --git a/docs/cli/job/describe.md → docs/cli/job/describe.mdx b/docs/cli/job/describe.md → docs/cli/job/describe.mdx
@@ -1,3 +1,5 @@
+import GlobalFlags from './_job-global-flags.md';
+
 # Describe
 
 ## Description
@@ -20,20 +22,7 @@ bacalhau job describe [id] [flags]
 - `--pretty`:
   - Description: Pretty prints the output. This option is applicable only to `json` and `yaml` output formats.
 
-## Global Flags
-
-- `--api-host string`:
-  - Description: Specifies the host for the client and server to communicate through via REST. If the `BACALHAU_API_HOST` environment variable is set, this flag will be ignored.
-  - Default: `bootstrap.production.bacalhau.org`
-- `--api-port int`:
-  - Description: Determines the port for the client and server to communicate on using REST. If the `BACALHAU_API_PORT` environment variable is set, this flag will be ignored.
-  - Default: `1234`
-- `--log-mode logging-mode`:
-  - Description: Specifies the desired log format. Supported values include `default`, `station`, `json`, `combined`, and `event`.
-  - Default: `default`
-- `--repo string`:
-  - Description: Defines the path to the bacalhau repository.
-  - Default: `$HOME/.bacalhau`
+<GlobalFlags />
 
 ## Examples
 

diff --git a/docs/cli/job/executions.md → docs/cli/job/executions.mdx b/docs/cli/job/executions.md → docs/cli/job/executions.mdx
@@ -1,3 +1,5 @@
+import GlobalFlags from './_job-global-flags.md';
+
 # Executions
 
 ## Description
@@ -35,20 +37,7 @@ bacalhau job executions [id] [flags]
 - `--wide`:
   - Description: Prints full values in the table results without truncating any information.
 
-## Global Flags
-
-- `--api-host string`:
-  - Description: Specifies the host for the client and server to communicate through via REST. If the `BACALHAU_API_HOST` environment variable is set, this flag will be ignored.
-  - Default: `bootstrap.production.bacalhau.org`
-- `--api-port int`:
-  - Description: Determines the port for the client and server to communicate on using REST. If the `BACALHAU_API_PORT` environment variable is set, this flag will be ignored.
-  - Default: `1234`
-- `--log-mode logging-mode`:
-  - Description: Specifies the desired log format. Supported values include `default`, `station`, `json`, `combined`, and `event`.
-  - Default: `default`
-- `--repo string`:
-  - Description: Defines the path to the bacalhau repository.
-  - Default: `$HOME/.bacalhau`
+<GlobalFlags />
 
 ## Examples
 

diff --git a/docs/cli/job/get.md → docs/cli/job/get.mdx b/docs/cli/job/get.md → docs/cli/job/get.mdx
@@ -1,3 +1,5 @@
+import GlobalFlags from './_job-global-flags.md';
+
 # Get
 
 ## Description
@@ -21,20 +23,7 @@ bacalhau job get [id] [flags]
 - `--raw`:
   - Description: Download raw result CIDs instead of merging multiple CIDs into a single result.
 
-## Global Flags
-
-- `--api-host string`:
-  - Description: Defines the host for client-server communication via REST. Overridden by the `BACALHAU_API_HOST` environment variable, if set.
-  - Default: `bootstrap.production.bacalhau.org`
-- `--api-port int`:
-  - Description: Sets the port for RESTful communication between the client and server. The `BACALHAU_API_PORT` environment variable takes precedence if set.
-  - Default: `1234`
-- `--log-mode logging-mode`:
-  - Description: Designates the desired log format. Options include `default`, `station`, `json`, `combined`, and `event`.
-  - Default: `default`
-- `--repo string`:
-  - Description: Points to the bacalhau repository location.
-  - Default: `$HOME/.bacalhau`
+<GlobalFlags />
 
 ## Examples
 

diff --git a/docs/cli/job/history.md → docs/cli/job/history.mdx b/docs/cli/job/history.md → docs/cli/job/history.mdx
@@ -1,3 +1,5 @@
+import GlobalFlags from './_job-global-flags.md';
+
 # History
 
 ## Description
@@ -41,20 +43,7 @@ bacalhau job history [id] [flags]
 - `--wide`:
   - Description: Presents full values in the table results, preventing truncation.
 
-## Global Flags
-
-- `--api-host string`:
-  - Description: Defines the host for client-server communication via REST. Overridden by the `BACALHAU_API_HOST` environment variable, if set.
-  - Default: `bootstrap.production.bacalhau.org`
-- `--api-port int`:
-  - Description: Sets the port for RESTful communication between the client and server. The `BACALHAU_API_PORT` environment variable takes precedence if set.
-  - Default: `1234`
-- `--log-mode logging-mode`:
-  - Description: Designates the desired log format. Options include `default`, `station`, `json`, `combined`, and `event`.
-  - Default: `default`
-- `--repo string`:
-  - Description: Points to the bacalhau repository location.
-  - Default: `$HOME/.bacalhau`
+<GlobalFlags />
 
 ## Examples