Skip to content

Commit 24db747

Browse files
Add global includes and rejib
Signed-off-by: Chris Chinchilla <[email protected]>
1 parent 798692a commit 24db747

21 files changed

+103
-231
lines changed

docs/cli/agent/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ bacalhau agent [command]
1010

1111
## Available Commands
1212

13-
1. [**alive**](alive.md):
13+
1. [**alive**](alive.mdx):
1414

1515
- Description: Retrieves the agent's liveness and health information. This can be helpful to determine if the agent is running and healthy.
1616
- Usage:
@@ -19,7 +19,7 @@ bacalhau agent [command]
1919
bacalhau agent alive
2020
```
2121

22-
2. [**node**](node.md):
22+
2. [**node**](node.mdx):
2323

2424
- 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.
2525
- Usage:
@@ -28,7 +28,7 @@ bacalhau agent [command]
2828
bacalhau agent node
2929
```
3030
31-
3. [**version**](version.md):
31+
3. [**version**](version.mdx):
3232
3333
- Description: Retrieves the Bacalhau version of the agent. This can be beneficial for ensuring compatibility or checking for updates.
3434
- Usage:
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
## Global Flags
2+
3+
- `--api-host string`:
4+
- 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.
5+
- Default: `bootstrap.production.bacalhau.org`
6+
- `--api-port int`:
7+
- Description: Specifies the port for REST communication. If the `BACALHAU_API_PORT` environment variable is set, this flag will be ignored.
8+
- Default: `1234`
9+
- `--log-mode logging-mode`:
10+
- Description: Sets the desired log format. Options are: `default`, `station`, `json`, `combined`, and `event`.
11+
- Default: `default`
12+
- `--repo string`:
13+
- Description: Defines the path to the bacalhau repository.
14+
- Default: \`\`$HOME/.bacalhau\`

docs/cli/agent/alive.md renamed to docs/cli/agent/alive.mdx

Lines changed: 3 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
import GlobalFlags from './_agent-global-flags.md';
2+
13
# Alive
24

35
## Description
@@ -21,20 +23,7 @@ bacalhau agent alive [flags]
2123
- `--pretty`:
2224
- Description: Formats the output for enhanced readability. This flag is relevant only when using JSON or YAML output formats.
2325

24-
## Global Flags
25-
26-
- `--api-host string`:
27-
- 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.
28-
- Default: `bootstrap.production.bacalhau.org`
29-
- `--api-port int`:
30-
- Description: Specifies the port for REST communication. If the `BACALHAU_API_PORT` environment variable is set, this flag will be ignored.
31-
- Default: `1234`
32-
- `--log-mode logging-mode`:
33-
- Description: Sets the desired log format. Options are: `default`, `station`, `json`, `combined`, and `event`.
34-
- Default: `default`
35-
- `--repo string`:
36-
- Description: Defines the path to the bacalhau repository.
37-
- Default: \`\`$HOME/.bacalhau\`
26+
<GlobalFlags />
3827

3928
## Examples
4029

docs/cli/agent/node.md renamed to docs/cli/agent/node.mdx

Lines changed: 3 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
import GlobalFlags from './_agent-global-flags.md';
2+
13
# Node
24

35
## Description
@@ -21,20 +23,7 @@ bacalhau agent node [flags]
2123
- `--pretty`:
2224
- Beautifies the output when using JSON or YAML formats.
2325

24-
## Global Flags
25-
26-
- `--api-host string`:
27-
- The host for REST communication. Overrides the `BACALHAU_API_HOST` environment variable.
28-
- Default: `bootstrap.production.bacalhau.org`
29-
- `--api-port int`:
30-
- The port for REST communication. Overridden if `BACALHAU_API_PORT` environment variable is set.
31-
- Default: `1234`
32-
- `--log-mode logging-mode`:
33-
- Specifies the log format. Choices are: `default`, `station`, `json`, `combined`, `event`.
34-
- Default: `default`
35-
- `--repo string`:
36-
- Path to the bacalhau repository.
37-
- Default: \`\`$HOME/.bacalhau\`
26+
<GlobalFlags />
3827

3928
## Examples
4029

docs/cli/agent/version.md renamed to docs/cli/agent/version.mdx

Lines changed: 3 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
import GlobalFlags from './_agent-global-flags.md';
2+
13
# Version
24

35
The `bacalhau agent version` command is used to obtain the version of the bacalhau agent.
@@ -21,21 +23,7 @@ bacalhau agent version [flags]
2123
- **`--pretty`**:
2224
- Used for pretty printing the output, enhancing readability. This flag is applicable only for the "json" and "yaml" output formats.
2325

24-
## Global Flags:
25-
26-
- **`--api-host string`**:
27-
- Designates the host for client-server communication via REST. If the `BACALHAU_API_HOST` environment variable is present, this flag will be disregarded.
28-
- Default: `"bootstrap.production.bacalhau.org"`
29-
- **`--api-port int`**:
30-
- Defines the port for client-server communication through REST. This flag becomes irrelevant if the `BACALHAU_API_PORT` environment variable is specified.
31-
- Default: `1234`
32-
- **`--log-mode logging-mode`**:
33-
- Specifies the desired logging format.
34-
- Options: `'default','station','json','combined','event'`
35-
- Default: `'default'`
36-
- **`--repo string`**:
37-
- Indicates the path to the bacalhau repository.
38-
- Default: `"`$HOME/.bacalhau"\`
26+
<GlobalFlags />
3927

4028
## Examples
4129

docs/cli/job/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ bacalhau job [command]
1010

1111
## Available Commands
1212

13-
1. [**describe**](./describe.md):
13+
1. [**describe**](./describe.mdx):
1414

1515
- Description: Retrieves detailed information of a job using its ID.
1616
- Usage:
@@ -19,7 +19,7 @@ bacalhau job [command]
1919
bacalhau job describe
2020
```
2121

22-
2. [**executions**](./executions.md):
22+
2. [**executions**](./executions.mdx):
2323

2424
- Description: Lists all executions associated with a job, identified by its ID.
2525
- Usage:
@@ -28,7 +28,7 @@ bacalhau job [command]
2828
bacalhau job executions
2929
```
3030

31-
3. [**history**](./history.md):
31+
3. [**history**](./history.mdx):
3232

3333
- Description: Enumerates the historical events related to a job, identified by its ID.
3434
- Usage:
@@ -37,7 +37,7 @@ bacalhau job [command]
3737
bacalhau job history
3838
```
3939

40-
4. [**list**](./list.md):
40+
4. [**list**](./list.mdx):
4141

4242
- Description: Provides an overview of all submitted jobs.
4343
- Usage:
@@ -46,7 +46,7 @@ bacalhau job [command]
4646
bacalhau job list
4747
```
4848

49-
5. [**logs**](./logs.md):
49+
5. [**logs**](./logs.mdx):
5050

5151
- Description: Fetches and streams the logs from a currently executing job.
5252
- Usage:
@@ -55,7 +55,7 @@ bacalhau job [command]
5555
bacalhau job logs
5656
```
5757

58-
6. [**run**](./run.md):
58+
6. [**run**](./run.mdx):
5959

6060
- Description: Submits a job for execution using either a JSON or YAML configuration file.
6161
- Usage:
@@ -64,7 +64,7 @@ bacalhau job [command]
6464
bacalhau job run
6565
```
6666

67-
7. [**stop**](./stop.md):
67+
7. [**stop**](./stop.mdx):
6868

6969
- Description: Halts a previously submitted job.
7070
- Usage:

docs/cli/job/_job-global-flags.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
## Global Flags
2+
3+
- `--api-host string`:
4+
- 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.
5+
- Default: `bootstrap.production.bacalhau.org`
6+
- `--api-port int`:
7+
- 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.
8+
- Default: `1234`
9+
- `--log-mode logging-mode`:
10+
- Description: Specifies the desired log format. Supported values include `default`, `station`, `json`, `combined`, and `event`.
11+
- Default: `default`
12+
- `--repo string`:
13+
- Description: Defines the path to the bacalhau repository.
14+
- Default: `$HOME/.bacalhau`

docs/cli/job/describe.md renamed to docs/cli/job/describe.mdx

Lines changed: 3 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
import GlobalFlags from './_job-global-flags.md';
2+
13
# Describe
24

35
## Description
@@ -20,20 +22,7 @@ bacalhau job describe [id] [flags]
2022
- `--pretty`:
2123
- Description: Pretty prints the output. This option is applicable only to `json` and `yaml` output formats.
2224

23-
## Global Flags
24-
25-
- `--api-host string`:
26-
- 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.
27-
- Default: `bootstrap.production.bacalhau.org`
28-
- `--api-port int`:
29-
- 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.
30-
- Default: `1234`
31-
- `--log-mode logging-mode`:
32-
- Description: Specifies the desired log format. Supported values include `default`, `station`, `json`, `combined`, and `event`.
33-
- Default: `default`
34-
- `--repo string`:
35-
- Description: Defines the path to the bacalhau repository.
36-
- Default: `$HOME/.bacalhau`
25+
<GlobalFlags />
3726

3827
## Examples
3928

docs/cli/job/executions.md renamed to docs/cli/job/executions.mdx

Lines changed: 3 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
import GlobalFlags from './_job-global-flags.md';
2+
13
# Executions
24

35
## Description
@@ -35,20 +37,7 @@ bacalhau job executions [id] [flags]
3537
- `--wide`:
3638
- Description: Prints full values in the table results without truncating any information.
3739

38-
## Global Flags
39-
40-
- `--api-host string`:
41-
- 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.
42-
- Default: `bootstrap.production.bacalhau.org`
43-
- `--api-port int`:
44-
- 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.
45-
- Default: `1234`
46-
- `--log-mode logging-mode`:
47-
- Description: Specifies the desired log format. Supported values include `default`, `station`, `json`, `combined`, and `event`.
48-
- Default: `default`
49-
- `--repo string`:
50-
- Description: Defines the path to the bacalhau repository.
51-
- Default: `$HOME/.bacalhau`
40+
<GlobalFlags />
5241

5342
## Examples
5443

docs/cli/job/history.md renamed to docs/cli/job/history.mdx

Lines changed: 3 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
import GlobalFlags from './_job-global-flags.md';
2+
13
# History
24

35
## Description
@@ -41,20 +43,7 @@ bacalhau job history [id] [flags]
4143
- `--wide`:
4244
- Description: Presents full values in the table results, preventing truncation.
4345

44-
## Global Flags
45-
46-
- `--api-host string`:
47-
- Description: Defines the host for client-server communication via REST. Overridden by the `BACALHAU_API_HOST` environment variable, if set.
48-
- Default: `bootstrap.production.bacalhau.org`
49-
- `--api-port int`:
50-
- Description: Sets the port for RESTful communication between the client and server. The `BACALHAU_API_PORT` environment variable takes precedence if set.
51-
- Default: `1234`
52-
- `--log-mode logging-mode`:
53-
- Description: Designates the desired log format. Options include `default`, `station`, `json`, `combined`, and `event`.
54-
- Default: `default`
55-
- `--repo string`:
56-
- Description: Points to the bacalhau repository location.
57-
- Default: `$HOME/.bacalhau`
46+
<GlobalFlags />
5847

5948
## Examples
6049

0 commit comments

Comments
 (0)