diff --git a/docs/cli/agent/README.md b/docs/cli/agent/README.mdx
similarity index 59%
rename from docs/cli/agent/README.md
rename to docs/cli/agent/README.mdx
index 3d6922e..bf05664 100644
--- a/docs/cli/agent/README.md
+++ b/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\`
+
\ No newline at end of file
diff --git a/docs/cli/agent/_agent-global-flags.md b/docs/cli/agent/_agent-global-flags.md
new file mode 100644
index 0000000..44e29f5
--- /dev/null
+++ 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\`
\ No newline at end of file
diff --git a/docs/cli/agent/alive.md b/docs/cli/agent/alive.mdx
similarity index 59%
rename from docs/cli/agent/alive.md
rename to docs/cli/agent/alive.mdx
index 0af4120..20cd249 100644
--- a/docs/cli/agent/alive.md
+++ b/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\`
+
## Examples
diff --git a/docs/cli/agent/node.md b/docs/cli/agent/node.mdx
similarity index 60%
rename from docs/cli/agent/node.md
rename to docs/cli/agent/node.mdx
index 7baaf8a..370b9e6 100644
--- a/docs/cli/agent/node.md
+++ b/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\`
+
## Examples
diff --git a/docs/cli/agent/version.md b/docs/cli/agent/version.mdx
similarity index 70%
rename from docs/cli/agent/version.md
rename to docs/cli/agent/version.mdx
index 8ec3940..efe4e79 100644
--- a/docs/cli/agent/version.md
+++ b/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"\`
+
## Examples
diff --git a/docs/cli/job/README.md b/docs/cli/job/README.mdx
similarity index 61%
rename from docs/cli/job/README.md
rename to docs/cli/job/README.mdx
index 2b4e0cc..98ca3c1 100644
--- a/docs/cli/job/README.md
+++ b/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,7 +39,7 @@ 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:
@@ -45,7 +47,8 @@ bacalhau job [command]
```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`
+
diff --git a/docs/cli/job/_job-global-flags.md b/docs/cli/job/_job-global-flags.md
new file mode 100644
index 0000000..2690d96
--- /dev/null
+++ 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`
\ No newline at end of file
diff --git a/docs/cli/job/describe.md b/docs/cli/job/describe.mdx
similarity index 58%
rename from docs/cli/job/describe.md
rename to docs/cli/job/describe.mdx
index 4de2550..ba0d5e7 100644
--- a/docs/cli/job/describe.md
+++ b/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`
+
## Examples
diff --git a/docs/cli/job/executions.md b/docs/cli/job/executions.mdx
similarity index 78%
rename from docs/cli/job/executions.md
rename to docs/cli/job/executions.mdx
index 21f7fc2..4807345 100644
--- a/docs/cli/job/executions.md
+++ b/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`
+
## Examples
diff --git a/docs/cli/job/get.md b/docs/cli/job/get.mdx
similarity index 50%
rename from docs/cli/job/get.md
rename to docs/cli/job/get.mdx
index a23f64f..12ffa14 100644
--- a/docs/cli/job/get.md
+++ b/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`
+
## Examples
diff --git a/docs/cli/job/history.md b/docs/cli/job/history.mdx
similarity index 82%
rename from docs/cli/job/history.md
rename to docs/cli/job/history.mdx
index 0f89be9..4ef5fff 100644
--- a/docs/cli/job/history.md
+++ b/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`
+
## Examples
diff --git a/docs/cli/job/list.md b/docs/cli/job/list.mdx
similarity index 81%
rename from docs/cli/job/list.md
rename to docs/cli/job/list.mdx
index 06713ec..96b1875 100644
--- a/docs/cli/job/list.md
+++ b/docs/cli/job/list.mdx
@@ -1,3 +1,5 @@
+import GlobalFlags from './_job-global-flags.md';
+
# List
## Description
@@ -38,20 +40,7 @@ bacalhau job list [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`
+
## Examples
diff --git a/docs/cli/job/logs.md b/docs/cli/job/logs.mdx
similarity index 73%
rename from docs/cli/job/logs.md
rename to docs/cli/job/logs.mdx
index 06afe1c..5991bf3 100644
--- a/docs/cli/job/logs.md
+++ b/docs/cli/job/logs.mdx
@@ -1,3 +1,5 @@
+import GlobalFlags from './_job-global-flags.md';
+
# Logs
## Description
@@ -17,20 +19,7 @@ bacalhau job logs [id] [flags]
2. `-h`, `--help`:
- Description: Display help information for the `logs` command.
-## Global Flags
-
-1. `--api-host string`:
- - Description: Specifies the host for the client and server to communicate through REST. This flag is disregarded if the `BACALHAU_API_HOST` environment variable is set.
- - Default: `bootstrap.production.bacalhau.org`
-2. `--api-port int`:
- - Description: Sets the port for RESTful communication between the client and server. If the `BACALHAU_API_PORT` environment variable is available, this flag is ignored.
- - Default: `1234`
-3. `--log-mode logging-mode`:
- - Description: Determines the desired log format. Available options include `default`, `station`, `json`, `combined`, and `event`.
- - Default: `default`
-4. `--repo string`:
- - Description: Specifies the path to the bacalhau repository.
- - Default: `$HOME/.bacalhau`
+
## Examples
diff --git a/docs/cli/job/run.md b/docs/cli/job/run.mdx
similarity index 93%
rename from docs/cli/job/run.md
rename to docs/cli/job/run.mdx
index d1329fa..1bdf43a 100644
--- a/docs/cli/job/run.md
+++ b/docs/cli/job/run.mdx
@@ -1,3 +1,5 @@
+import GlobalFlags from './_job-global-flags.md';
+
# Run
## Description
@@ -31,20 +33,7 @@ bacalhau job run [flags]
- `-h`, `--help`:
- Description: Displays help information for the `run` command.
-## Global Flags
-
-- `--api-host string`:
- - Description: Specifies the host used for RESTful communication between the client and server. The flag is disregarded if `BACALHAU_API_HOST` environment variable is set.
- - Default: `bootstrap.production.bacalhau.org`
-- `--api-port int`:
- - Description: Determines the port for REST communication. If `BACALHAU_API_PORT` environment variable is set, this flag will be ignored.
- - Default: `1234`
-- `--log-mode logging-mode`:
- - Description: Selects the desired log format. Options include: `default`, `station`, `json`, `combined`, and `event`.
- - Default: `default`
-- `--repo string`:
- - Description: Defines the path to the bacalhau repository.
- - Default: `$HOME/.bacalhau`
+
## Examples
diff --git a/docs/cli/job/stop.md b/docs/cli/job/stop.mdx
similarity index 67%
rename from docs/cli/job/stop.md
rename to docs/cli/job/stop.mdx
index ae2e260..def68b5 100644
--- a/docs/cli/job/stop.md
+++ b/docs/cli/job/stop.mdx
@@ -1,3 +1,5 @@
+import GlobalFlags from './_job-global-flags.md';
+
# Stop
## Description
@@ -17,20 +19,7 @@ bacalhau job stop [id] [flags]
- `-h`, `--help`:
- Description: Displays help information for the `stop` command.
-## Global Flags
-
-- `--api-host string`:
- - Description: Specifies the host used for RESTful communication between the client and server. The flag is disregarded if `BACALHAU_API_HOST` environment variable is set.
- - Default: `bootstrap.production.bacalhau.org`
-- `--api-port int`:
- - Description: Determines the port for REST communication. If `BACALHAU_API_PORT` environment variable is set, this flag will be ignored.
- - Default: `1234`
-- `--log-mode logging-mode`:
- - Description: Selects the desired log format. Options include: `default`, `station`, `json`, `combined`, and `event`.
- - Default: `default`
-- `--repo string`:
- - Description: Defines the path to the bacalhau repository.
- - Default: `$HOME/.bacalhau`
+
## Examples
diff --git a/docs/cli/node/README.md b/docs/cli/node/README.mdx
similarity index 56%
rename from docs/cli/node/README.md
rename to docs/cli/node/README.mdx
index 366b174..54a15ee 100644
--- a/docs/cli/node/README.md
+++ b/docs/cli/node/README.mdx
@@ -1,3 +1,5 @@
+import GlobalFlags from './_node-global-flags.md';
+
# Node
The `bacalhau node` command provides a set of sub-commands to query and manage node-related information within Bacalhau. With these tools, users can access specific details about nodes, list all network nodes, and more.
@@ -10,7 +12,7 @@ bacalhau node [command]
## Available Commands
-1. [**approve**](approve.md):
+1. [**approve**](approve.mdx):
- Description: Approves a single node to join the cluster.
- Usage:
@@ -19,7 +21,7 @@ bacalhau node [command]
bacalhau node approve
```
-2. [**delete**](delete.md):
+2. [**delete**](delete.mdx):
- Description: Deletes a node from the cluster using its ID.
- Usage:
@@ -28,7 +30,7 @@ bacalhau node [command]
bacalhau node delete
```
-3. [**describe**](describe.md):
+3. [**describe**](describe.mdx):
- Description: Retrieves detailed information of a node using its ID.
- Usage:
@@ -37,7 +39,7 @@ bacalhau node [command]
bacalhau node describe
```
-4. [**list**](list.md):
+4. [**list**](list.mdx):
- Description: Lists the details of all nodes present in the network.
- Usage:
@@ -46,7 +48,7 @@ bacalhau node [command]
bacalhau node list
```
-5. [**reject**](reject.md):
+5. [**reject**](reject.mdx):
- Description: Reject a specific node's request to join the cluster.
- Usage:
@@ -66,17 +68,4 @@ bacalhau node [command] --help
- `-h`, `--help`:
- Description: Shows the help information for the `node` command.
-## Global Flags
-
-- `--api-host string`:
- - Description: Specifies the host for RESTful communication between the client and server. The flag will be ignored if the `BACALHAU_API_HOST` environment variable is set.
- - Default: `bootstrap.production.bacalhau.org`
-- `--api-port int`:
- - Description: Designates the port for RESTful communication. The flag will be bypassed if the `BACALHAU_API_PORT` environment variable is active.
- - Default: `1234`
-- `--log-mode logging-mode`:
- - Description: Chooses the preferred log format. Available choices are: `default`, `station`, `json`, `combined`, and `event`.
- - Default: `default`
-- `--repo string`:
- - Description: Specifies the path to the bacalhau repository.
- - Default: `/Users/walid/.bacalhau`
+
\ No newline at end of file
diff --git a/docs/cli/node/_node-global-flags.md b/docs/cli/node/_node-global-flags.md
new file mode 100644
index 0000000..0599d8a
--- /dev/null
+++ b/docs/cli/node/_node-global-flags.md
@@ -0,0 +1,15 @@
+## Global Flags
+
+- `--api-host string`:
+ - Specifies the host for client-server communication through REST. This flag is overridden if the `BACALHAU_API_HOST` environment variable is set.
+ - Default: `"bootstrap.production.bacalhau.org"`
+- `--api-port int`:
+ - Designates the port for REST-based communication between client and server. This flag is overlooked if the `BACALHAU_API_PORT` environment variable is defined.
+ - Default: `1234`
+- `--log-mode logging-mode`:
+ - Determines the log format preference.
+ - Options: `'default','station','json','combined','event'`
+ - Default: `'default'`
+- `--repo string`:
+ - Points to the bacalhau repository's path.
+ - Default: `"`$HOME/.bacalhau"\`
\ No newline at end of file
diff --git a/docs/cli/node/approve.md b/docs/cli/node/approve.mdx
similarity index 56%
rename from docs/cli/node/approve.md
rename to docs/cli/node/approve.mdx
index 8eb436e..aa78c2d 100644
--- a/docs/cli/node/approve.md
+++ b/docs/cli/node/approve.mdx
@@ -1,3 +1,5 @@
+import GlobalFlags from './_node-global-flags.md';
+
# Approve
The `bacalhau node approve` command offers administrators the ability to approve the cluster membership for a node using its name.
@@ -21,21 +23,7 @@ bacalhau node approve [id] [flags]
- `-m message`:
- A message to be attached to the approval action.
-## Global Flags
-
-- `--api-host string`:
- - Specifies the host for client-server communication through REST. This flag is overridden if the `BACALHAU_API_HOST` environment variable is set.
- - Default: `"bootstrap.production.bacalhau.org"`
-- `--api-port int`:
- - Designates the port for REST-based communication between client and server. This flag is overlooked if the `BACALHAU_API_PORT` environment variable is defined.
- - Default: `1234`
-- `--log-mode logging-mode`:
- - Determines the log format preference.
- - Options: `'default','station','json','combined','event'`
- - Default: `'default'`
-- `--repo string`:
- - Points to the bacalhau repository's path.
- - Default: `"`$HOME/.bacalhau"\`
+
## Examples
diff --git a/docs/cli/node/delete.md b/docs/cli/node/delete.mdx
similarity index 54%
rename from docs/cli/node/delete.md
rename to docs/cli/node/delete.mdx
index 63fca42..2148452 100644
--- a/docs/cli/node/delete.md
+++ b/docs/cli/node/delete.mdx
@@ -1,3 +1,5 @@
+import GlobalFlags from './_node-global-flags.md';
+
# Delete
The `bacalhau node delete` command offers administrators the ability to remove a node from the cluster using its name.
@@ -21,21 +23,7 @@ bacalhau node delete [id] [flags]
- `-m message`:
- A message to be attached to the deletion action.
-## Global Flags
-
-- `--api-host string`:
- - Specifies the host for client-server communication through REST. This flag is overridden if the `BACALHAU_API_HOST` environment variable is set.
- - Default: `"bootstrap.production.bacalhau.org"`
-- `--api-port int`:
- - Designates the port for REST-based communication between client and server. This flag is overlooked if the `BACALHAU_API_PORT` environment variable is defined.
- - Default: `1234`
-- `--log-mode logging-mode`:
- - Determines the log format preference.
- - Options: `'default','station','json','combined','event'`
- - Default: `'default'`
-- `--repo string`:
- - Points to the bacalhau repository's path.
- - Default: `"`$HOME/.bacalhau"\`
+
## Examples
diff --git a/docs/cli/node/describe.md b/docs/cli/node/describe.mdx
similarity index 65%
rename from docs/cli/node/describe.md
rename to docs/cli/node/describe.mdx
index 439acdd..b974e2c 100644
--- a/docs/cli/node/describe.md
+++ b/docs/cli/node/describe.mdx
@@ -1,3 +1,5 @@
+import GlobalFlags from './_node-global-flags.md';
+
# Describe
The `bacalhau node describe` command offers users the ability to retrieve detailed information about a specific node using its unique identifier.
@@ -25,21 +27,7 @@ bacalhau node describe [id] [flags]
- `--pretty`:
- When this flag is used, the command will pretty print the output. This is applicable only for outputs in `json` and `yaml` formats.
-## Global Flags
-
-- `--api-host string`:
- - Specifies the host for client-server communication through REST. This flag is overridden if the `BACALHAU_API_HOST` environment variable is set.
- - Default: `"bootstrap.production.bacalhau.org"`
-- `--api-port int`:
- - Designates the port for REST-based communication between client and server. This flag is overlooked if the `BACALHAU_API_PORT` environment variable is defined.
- - Default: `1234`
-- `--log-mode logging-mode`:
- - Determines the log format preference.
- - Options: `'default','station','json','combined','event'`
- - Default: `'default'`
-- `--repo string`:
- - Points to the bacalhau repository's path.
- - Default: `"`$HOME/.bacalhau"\`
+
## Examples
diff --git a/docs/cli/node/list.md b/docs/cli/node/list.mdx
similarity index 87%
rename from docs/cli/node/list.md
rename to docs/cli/node/list.mdx
index 1868d47..dca4f8d 100644
--- a/docs/cli/node/list.md
+++ b/docs/cli/node/list.mdx
@@ -1,3 +1,5 @@
+import GlobalFlags from './_node-global-flags.md';
+
# List
The `bacalhau node list` command is designed to provide users with a comprehensive list of network nodes along with details based on specified flags.
@@ -45,21 +47,7 @@ bacalhau node list [flags]
- `--wide`:
- Display full values in the output table, without truncation.
-## Global Flags
-
-- `--api-host string`:
- - Specify the host for client-server communication via REST. This gets ignored if the `BACALHAU_API_HOST` environment variable is defined.
- - Default: `"bootstrap.production.bacalhau.org"`.
-- `--api-port int`:
- - Specify the port for RESTful communication between client and server. Gets overlooked if the `BACALHAU_API_PORT` environment variable is set.
- - Default: `1234`.
-- `--log-mode logging-mode`:
- - Choose the desired log format.
- - Options: `'default', 'station', 'json', 'combined', 'event'`.
- - Default: `'default'`.
-- `--repo string`:
- - Point to the directory path of the bacalhau repository.
- - Default: `"`$HOME/.bacalhau"\`.
+
## Examples
diff --git a/docs/cli/node/reject.md b/docs/cli/node/reject.mdx
similarity index 57%
rename from docs/cli/node/reject.md
rename to docs/cli/node/reject.mdx
index 41c71f6..dc668fb 100644
--- a/docs/cli/node/reject.md
+++ b/docs/cli/node/reject.mdx
@@ -1,3 +1,5 @@
+import GlobalFlags from './_node-global-flags.md';
+
# Reject
The `bacalhau node reject` command offers administrators the ability to reject a compute node's request to join the cluster.
@@ -21,21 +23,7 @@ bacalhau node rejected [id] [flags]
- `-m message`:
- A message to be attached to the rejection action.
-## Global Flags
-
-- `--api-host string`:
- - Specifies the host for client-server communication through REST. This flag is overridden if the `BACALHAU_API_HOST` environment variable is set.
- - Default: `"bootstrap.production.bacalhau.org"`
-- `--api-port int`:
- - Designates the port for REST-based communication between client and server. This flag is overlooked if the `BACALHAU_API_PORT` environment variable is defined.
- - Default: `1234`
-- `--log-mode logging-mode`:
- - Determines the log format preference.
- - Options: `'default','station','json','combined','event'`
- - Default: `'default'`
-- `--repo string`:
- - Points to the bacalhau repository's path.
- - Default: `"`$HOME/.bacalhau"\`
+
## Examples