Skip to content

Commit 962c0a5

Browse files
committed
docs: update jobs command documentation
1 parent cb99d98 commit 962c0a5

File tree

1 file changed

+34
-6
lines changed

1 file changed

+34
-6
lines changed

docs/Commands/jobs.md

Lines changed: 34 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,41 @@
11
## The jobs command
22

3-
43
## Synopsis
54

6-
7-
8-
bpipe jobs
9-
5+
bpipe jobs [options]
106

117
### Description
128

13-
Display a list of currently running Bpipe jobs.
9+
Display a list of currently running and recently completed Bpipe jobs.
10+
11+
### Options
12+
13+
-all Show all jobs, including completed ones
14+
-age <n> Show jobs up to n hours old (default: 24)
15+
-m <str> Match given substring on directory name
16+
-watch Show continuously updated display
17+
-sleep <n> Sleep time in ms when watching continuously (default: 10000)
18+
-u Only show each directory once with latest result
19+
20+
### Environment Variables
21+
22+
BPIPE_DB_DIR Directory where Bpipe stores its database of jobs and logs
23+
(default: ~/.bpipedb)
24+
25+
### Examples
26+
27+
# Show all jobs
28+
bpipe jobs -all
29+
30+
# Show jobs from last week
31+
bpipe jobs -age 168
32+
33+
# Show only jobs from directories containing "analysis"
34+
bpipe jobs -m analysis
35+
36+
# Monitor jobs continuously
37+
bpipe jobs -watch
38+
39+
# Use custom database location
40+
export BPIPE_DB_DIR=/data/bpipe/db
41+
bpipe jobs

0 commit comments

Comments
 (0)