Skip to content

Commit e787e45

Browse files
committed
doc: update README.md with all functionality
1 parent 37d5a98 commit e787e45

1 file changed

Lines changed: 22 additions & 4 deletions

File tree

README.md

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -69,26 +69,35 @@ Replace `<tag>` with the specific version tag you want to build, e.g., `v27.1`.
6969
Attest to non-codesigned build outputs:
7070

7171
```bash
72-
bgt attest <tag>
72+
bgt attest <tag> [--auto]
7373
```
7474

75+
The `--auto` flag will automatically sign using GPG and open a PR on GitHub.
76+
7577
### Codesign
7678

7779
Attach codesignatures to existing non-codesigned outputs and attest:
7880

7981
```bash
80-
bgt codesign <tag>
82+
bgt codesign <tag> [--auto]
8183
```
8284

85+
The `--auto` flag will automatically sign using GPG and open a PR on GitHub.
86+
8387
### Watch
8488

8589
Run a continuous watcher to monitor for new tags and automatically build them, optionally as a background daemon:
8690

8791
```bash
88-
bgt watch start <--daemon>
92+
bgt watch start [--daemon] [--auto] [--dry-run]
8993
```
9094

91-
Stop a background watcher daemon
95+
Where:
96+
- `--daemon` runs the watcher as a background process
97+
- `--auto` automatically signs using GPG and opens PRs on GitHub
98+
- `--dry-run` monitors for new tags without performing builds or signing
99+
100+
Stop a background watcher daemon:
92101

93102
```bash
94103
bgt watch stop
@@ -112,9 +121,18 @@ View the current configuration settings:
112121
bgt show-config
113122
```
114123

124+
### Warmup
125+
126+
Guix build current master to populate Guix caches:
127+
128+
```bash
129+
bgt warmup
130+
```
131+
115132
## Additional Options
116133

117134
- `--multi-package`: Use `JOBS=1 ADDITIONAL_GUIX_COMMON_FLAGS='--max-jobs=8'` for building. This can be added to any command.
135+
- `--debug`: Enable debug log level. This can be added to any command.
118136

119137
## Logging
120138

0 commit comments

Comments
 (0)