Skip to content

Commit f7a9290

Browse files
Add back job get docs (#124)
2 parents 798692a + cc04658 commit f7a9290

File tree

2 files changed

+61
-6
lines changed

2 files changed

+61
-6
lines changed

docs/cli/job/README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,16 +28,24 @@ bacalhau job [command]
2828
bacalhau job executions
2929
```
3030

31-
3. [**history**](./history.md):
31+
3. [**get**](./get.md):
32+
33+
- Description: Get the results of a job, identified by its ID.
34+
- Usage:
35+
36+
```bash
37+
bacalhau job get
38+
```
39+
40+
4. [**history**](./history.md):
3241

3342
- Description: Enumerates the historical events related to a job, identified by its ID.
3443
- Usage:
3544

3645
```bash
3746
bacalhau job history
3847
```
39-
40-
4. [**list**](./list.md):
48+
5. [**list**](./list.md):
4149

4250
- Description: Provides an overview of all submitted jobs.
4351
- Usage:
@@ -46,7 +54,7 @@ bacalhau job [command]
4654
bacalhau job list
4755
```
4856

49-
5. [**logs**](./logs.md):
57+
6. [**logs**](./logs.md):
5058

5159
- Description: Fetches and streams the logs from a currently executing job.
5260
- Usage:
@@ -55,7 +63,7 @@ bacalhau job [command]
5563
bacalhau job logs
5664
```
5765

58-
6. [**run**](./run.md):
66+
7. [**run**](./run.md):
5967

6068
- Description: Submits a job for execution using either a JSON or YAML configuration file.
6169
- Usage:
@@ -64,7 +72,7 @@ bacalhau job [command]
6472
bacalhau job run
6573
```
6674

67-
7. [**stop**](./stop.md):
75+
8. [**stop**](./stop.md):
6876

6977
- Description: Halts a previously submitted job.
7078
- Usage:

docs/cli/job/get.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Get
2+
3+
## Description
4+
5+
The `bacalhau job get` command is used to get the results of the job, including stdout and stderr.
6+
7+
## Usage
8+
9+
```bash
10+
bacalhau job get [id] [flags]
11+
```
12+
13+
## Flags
14+
15+
- `--download-timeout-secs duration`:
16+
- Description: Timeout duration for IPFS downloads. (default 5m0s)
17+
- `-h`, `--help`:
18+
- Description: Display help for the `list` command.
19+
- `output-dir string`:
20+
- Description: Directory to write the output to.
21+
- `--raw`:
22+
- Description: Download raw result CIDs instead of merging multiple CIDs into a single result.
23+
24+
## Global Flags
25+
26+
- `--api-host string`:
27+
- Description: Defines the host for client-server communication via REST. Overridden by the `BACALHAU_API_HOST` environment variable, if set.
28+
- Default: `bootstrap.production.bacalhau.org`
29+
- `--api-port int`:
30+
- Description: Sets the port for RESTful communication between the client and server. The `BACALHAU_API_PORT` environment variable takes precedence if set.
31+
- Default: `1234`
32+
- `--log-mode logging-mode`:
33+
- Description: Designates the desired log format. Options include `default`, `station`, `json`, `combined`, and `event`.
34+
- Default: `default`
35+
- `--repo string`:
36+
- Description: Points to the bacalhau repository location.
37+
- Default: `$HOME/.bacalhau`
38+
39+
## Examples
40+
41+
1. **Get the results of a job**:
42+
43+
`bacalhau job get 51225160-807e-48b8-88c9-28311c7899e1`
44+
45+
2. **Get the results of a job, using a short ID**:
46+
47+
`bacalhau job get 51225160`

0 commit comments

Comments
 (0)