gflow 0.4.14

A lightweight, single-node job scheduler written in Rust.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130

# gflowd Reference

`gflowd` manages the local gflow daemon.

## Usage

```bash
gflowd [options] [command]
gflowd completion <shell>
```

## Common Examples

```bash
# Initialize config interactively
gflowd init

# Initialize config non-interactively with defaults
gflowd init --yes

# Start the daemon
gflowd up

# Start with restricted GPUs and random allocation
gflowd up --gpus 0,2 --gpu-allocation-strategy random

# Reload without downtime
gflowd reload

# Restart the daemon with a new GPU restriction
gflowd restart --gpus 0-3

# Check status or stop the daemon
gflowd status
gflowd down
```

## Global Options

- `-c, --config <path>`: use a custom config file
- `--cleanup`: clean up the configuration file
- `-v/-vv/-vvv/-vvvv`: increase daemon logging verbosity
- `-q`: reduce daemon logging verbosity

## Commands

### `gflowd init`

Create or update the configuration file via a guided wizard.

```bash
gflowd init [--yes] [--force] [--advanced] [--gpus <indices>] [--host <host>] [--port <port>] [--timezone <tz>] [--gpu-allocation-strategy <strategy>]
```

Options:

- `--yes`: accept all defaults without prompts
- `--force`: overwrite an existing config file
- `--advanced`: configure advanced options such as notifications
- `--gpus <indices>`: restrict scheduler-visible GPUs, for example `0,2` or `0-2`
- `--host <host>`: daemon host (default: `localhost`)
- `--port <port>`: daemon port (default: `59000`)
- `--timezone <tz>`: store a timezone like `Asia/Shanghai` or `UTC`; use `local` to leave it unset
- `--gpu-allocation-strategy <strategy>`: `sequential` or `random`

### `gflowd up`

Start the daemon in a tmux session.

```bash
gflowd up [--gpus <indices>] [--gpu-allocation-strategy <strategy>]
```

### `gflowd reload`

Reload the daemon with zero downtime.

```bash
gflowd reload [--gpus <indices>] [--gpu-allocation-strategy <strategy>]
```

Use this when you want to refresh the running daemon without stopping it first.

### `gflowd restart`

Stop the daemon and start it again.

```bash
gflowd restart [--gpus <indices>] [--gpu-allocation-strategy <strategy>]
```

Use this when a full restart is acceptable or needed.

### `gflowd status`

Show whether the daemon is running and responding to health checks.

```bash
gflowd status
```

### `gflowd down`

Stop the daemon.

```bash
gflowd down
```

### `gflowd completion <shell>`

Generate shell completion scripts.

```bash
gflowd completion bash
gflowd completion zsh
gflowd completion fish
```

## Notes

- `--gpus` affects which GPUs the scheduler may allocate for new work.
- `--gpu-allocation-strategy` accepts `sequential` or `random`.
- `gflowd up`, `reload`, and `restart` all accept the same GPU-related overrides.

## See Also

- [Configuration](../user-guide/configuration)
- [GPU Management](../user-guide/gpu-management)
- [Quick Reference](./quick-reference)