Skip to content

Commit 2df57a7

Browse files
committed
docs: README
1 parent 72077e4 commit 2df57a7

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,19 @@ In your `config.fish` or in a separate `completions/turm.fish` file, add the fol
5252
turm completion fish | source
5353
```
5454

55+
## Usage
56+
57+
Run `turm` in your terminal. By default, it shows all jobs in the queue.
58+
```shell
59+
turm
60+
```
61+
62+
You can filter the jobs using the same options as `squeue`. For example, to show only your own jobs, sorted by descending job ID, including all job states (i.e., including completed and failed jobs):
63+
64+
```shell
65+
turm --sort=-id --me --states=ALL
66+
```
67+
5568
## How it works
5669

5770
`turm` obtains information about jobs by parsing the output of `squeue`.

0 commit comments

Comments
 (0)