1hut(1) General Commands Manual hut(1)
2
6 hut - A CLI tool for sr.ht
7
9 hut [commands...] [options...]
10
12 hut is a CLI companion utility to interact with sr.ht.
13
15 -h, --help
16 Show help message and quit. Can be used after a command to get more
17 information it.
18 --config
20 Explicitly select a configuration file that should be used over the
21 default configuration.
22 --instance
24 Select which sr.ht instance from the config file should be used. By
25 default the first one will be selected.
26
28 help <command>
29 Help about any command.
30 graphql <service>
32 Write a GraphQL query and execute it. The JSON response is written
33 to stdout. service is the sr.ht service to execute the query on
34 (for instance "meta" or "builds"). When this command is run from a
35 terminal, the query will be read from $EDITOR, otherwise it de‐
36 faults to stdin.
37 A tool like jq(1) can be used to prettify the output and process
39 the data. Example:
40 hut graphql meta <<EOF | jq '.me'
42 query {
43 me { canonicalName }
44 }
45 EOF
46 Options are:
48 --stdin
50 Read query from stdin.
51 -v, --var <key>=<value>
53 Set a raw variable. Example:
54 hut graphql meta -v username=emersion <<'EOF'
56 query($username: String!) {
57 userByName(username: $username) {
58 bio
59 }
60 }
61 EOF
62 init
64 Initialize hut's configuration file.
65 export <directory>
67 Export account data.
68 Note, only meta.sr.ht is supported at the moment.
70 builds
72 cancel <IDs...>
73 Cancel jobs.
74 list
76 List jobs.
77 resubmit <ID>
79 Resubmit a build.
80 Options are:
82 -e, --edit
84 Edit manifest with $EDITOR.
85 -f, --follow
87 Follow build logs.
88 -n, --note <string>
90 Provide a short job description.
91 -t, --tags <string>
93 Slash separated tags (e.g. "hut/test").
94 secrets
96 List secrets.
97 show [ID] [options...]
99 Show job status.
100 If no ID is specified, the latest build will be printed.
102 Options are:
104 -f, --follow
106 Follow job status.
107 ssh <ID>
109 Connect with SSH to a job.
110 submit [manifest...] [options...]
112 Submit a build manifest.
113 If no build manifest is specified, build manifests are discovered
115 at .build.yml and .builds/*.yml.
116 Options are:
118 -f, --follow
120 Follow build logs.
121 -n, --note <string>
123 Provide a short job description.
124 git
126 Options are:
127 -r, --repo <string>
129 Name of repository.
130 acl delete <ID>
132 Delete an ACL entry.
133 acl list [repo]
135 List ACL entries of a repo. Defaults to current repo.
136 acl update <user> [options...]
138 Update or add an ACL entry for user.
139 Options are:
141 -m, --mode <string>
143 Access mode to set (RW, RO).
144 artifact delete <ID>
146 Delete an artifact.
147 artifact list [options...]
149 List artifacts.
150 artifact upload <filename...> [options...]
152 Upload artifacts.
153 Options are:
155 --rev <string>
157 Revision tag. Defaults to the last Git tag.
158 create <name> [options...]
160 Create a repository.
161 Options are:
163 -c, --clone
165 Clone repository to CWD.
166 -d, --description <string>
168 Description of the repository.
169 --import-url <url>
171 Import the repository from the given URL.
172 -v, --visibility <string>
174 Visibility to use (public, unlisted, private). Defaults to pub‐
175 lic.
176 delete [repo] [options...]
178 Delete a repository. By default the current repo will be deleted.
179 Options are:
181 -y, --yes
183 Confirm deletion without prompt.
184 list [owner]
186 List repositories.
187 show [repo]
189 Display information about a repository.
190 user-webhook create [options...]
192 Create a user webhook. When this command is run from a terminal,
193 the query will be read from $EDITOR, otherwise it defaults to
194 stdin.
195 Options are:
197 -e, --events <strings...>
199 List of events that should trigger the webhook (REPO_CREATED,
200 REPO_UPDATE, REPO_DELETED). Required.
201 --stdin
203 Read query from stdin.
204 -u, --url <URL>
206 The payload URL which receives the POST request. Required.
207 user-webhook delete <ID>
209 Delete a user webhook.
210 user-webhook list
212 List user webhooks.
213 hg
215 create <name> [options...]
216 Create a repository.
217 Options are:
219 -d, --description <string>
221 Description of the repository.
222 -v, --visibility <string>
224 Visibility to use (public, unlisted, private). Defaults to pub‐
225 lic.
226 delete <repo> [options...]
228 Delete a repository.
229 Options are:
231 -y, --yes
233 Confirm deletion without prompt.
234 list [owner]
236 List repositories.
237 user-webhook create [options...]
239 Create a user webhook. When this command is run from a terminal,
240 the query will be read from $EDITOR, otherwise it defaults to
241 stdin.
242 Options are:
244 -e, --events <strings...>
246 List of events that should trigger the webhook (REPO_CREATED,
247 REPO_UPDATE, REPO_DELETED). Required.
248 --stdin
250 Read query from stdin.
251 -u, --url <URL>
253 The payload URL which receives the POST request. Required.
254 user-webhook delete <ID>
256 Delete a user webhook.
257 user-webhook list
259 List user webhooks.
260 lists
262 Options are:
263 -l, --mailing-list <name>
265 Select a mailing list.
266 By default, the mailing list configured for the current Git
268 repository will be selected.
269 acl delete <ID>
271 Delete an ACL entry.
272 acl list [list]
274 List ACL entries of a mailing list.
275 create <name> [options...]
277 Create a mailing list.
278 Options are:
280 --stdin
282 Read description from stdin.
283 -v, --visibility <string>
285 Visibility to use (public, unlisted, private). Defaults to pub‐
286 lic.
287 delete [list] [options...]
289 Delete a mailing list.
290 Options are:
292 -y, --yes
294 Confirm deletion without prompt.
295 list [owner]
297 List mailing lists.
298 patchset apply <ID>
300 Apply a patchset.
301 patchset list [list] [options...]
303 List patchsets in list.
304 Options are:
306 -u, --user
308 List patchsets by user instead of by list.
309 patchset show <ID>
311 Show a patchset.
312 patchset update <ID>
314 Update a patchset.
315 Options are:
317 -s, --status <string>
319 Patchset status to set (required).
320 subscribe [list]
322 Subscribe to a mailing list.
323 unsubscribe [list]
325 Unsubscribe from a mailing list.
326 user-webhook create [options...]
328 Create a user webhook. When this command is run from a terminal,
329 the query will be read from $EDITOR, otherwise it defaults to
330 stdin.
331 Options are:
333 -e, --events <strings...>
335 List of events that should trigger the webhook (LIST_CREATED,
336 LIST_UPDATED, LIST_DELETED, EMAIL_RECEIVED, PATCHSET_RECEIVED).
337 Required.
338 --stdin
340 Read query from stdin.
341 -u, --url <URL>
343 The payload URL which receives the POST request. Required.
344 user-webhook delete <ID>
346 Delete a user webhook.
347 user-webhook list
349 List user webhooks.
350 meta
352 audit-log
353 Display your audit log.
354 pgp-key create [path]
356 Upload a PGP public key and associate it with your account.
357 The public key must be in the armored format.
359 If path is not specified, the default public key from the local GPG
361 keyring is used.
362 pgp-key delete <ID>
364 Delete a PGP key from your account.
365 pgp-key list [username] [options...]
367 List PGP public keys.
368 Options are:
370 -r, --raw
372 Only print raw public key
373 show [username]
375 Show a user's profile.
376 If username is not specified, your profile is displayed.
378 ssh-key create [path]
380 Upload an SSH public key and associate it with your account.
381 If path is not specified, the default SSH public key is used.
383 ssh-key delete <ID>
385 Delete an SSH public key from your account.
386 ssh-key list [username] [options...]
388 List SSH public keys.
389 Options are:
391 -r, --raw
393 Only print raw public key
394 user-webhook create [options...]
396 Create a user webhook. When this command is run from a terminal,
397 the query will be read from $EDITOR, otherwise it defaults to
398 stdin.
399 Options are:
401 -e, --events <strings...>
403 List of events that should trigger the webhook (PROFILE_UPDATE,
404 PGP_KEY_ADDED, PGP_KEY_REMOVED, SSH_KEY_ADDED, SSH_KEY_RE‐
405 MOVED). Required.
406 --stdin
408 Read query from stdin.
409 -u, --url <URL>
411 The payload URL which receives the POST request. Required.
412 user-webhook delete <ID>
414 Delete a user webhook.
415 user-webhook list
417 List user webhooks.
418 pages
420 list
421 List registered sites.
422 publish [tarball] [options...]
424 Publish a website.
425 If tarball is not specified, standard input is used.
427 Options are:
429 -d, --domain <string>
431 Fully qualified domain name.
432 --not-found <string>
434 Path to serve for page not found responses
435 -p, --protocol <string>
437 Protocol to use (either HTTPS or GEMINI; defaults to HTTPS)
438 -s, --subdirectory <string>
440 If specified, only this subdirectory is updated, the rest of
441 the site is left untouched.
442 unpublish [options...]
444 Unpublish a website.
445 Options are:
447 -d, --domain <string>
449 Fully qualified domain name.
450 -p, --protocol <string>
452 Protocol to use (either HTTPS or GEMINI; defaults to HTTPS)
453 user-webhook create [options...]
455 Create a user webhook. When this command is run from a terminal,
456 the query will be read from $EDITOR, otherwise it defaults to
457 stdin.
458 Options are:
460 -e, --events <strings...>
462 List of events that should trigger the webhook (SITE_PUBLISHED,
463 SITE_UNPUBLISHED). Required.
464 --stdin
466 Read query from stdin.
467 -u, --url <URL>
469 The payload URL which receives the POST request. Required.
470 user-webhook delete <ID>
472 Delete a user webhook.
473 user-webhook list
475 List user webhooks.
476 paste
478 create <filenames...>
479 Create a new paste.
480 Options are:
482 -v, --visibility <string>
484 Visibility to use (public, unlisted, private). Defaults to un‐
485 listed.
486 -n, --name <string>
488 Name of the created paste. Only valid when reading from stdin.
489 delete <IDs...>
491 Delete pastes.
492 list
494 List pastes.
495 show <ID>
497 Display a paste.
498 update <ID> [options...]
500 Update a paste's visibility.
501 Options are:
503 -v, --visibility <string>
505 Visibility to use (public, unlisted, private)
506 user-webhook create [options...]
508 Create a user webhook. When this command is run from a terminal,
509 the query will be read from $EDITOR, otherwise it defaults to
510 stdin.
511 Options are:
513 -e, --events <strings...>
515 List of events that should trigger the webhook (PASTE_CREATED,
516 PASTE_UPDATED, PASTE_DELETED). Required.
517 --stdin
519 Read query from stdin.
520 -u, --url <URL>
522 The payload URL which receives the POST request. Required.
523 user-webhook delete <ID>
525 Delete a user webhook.
526 user-webhook list
528 List user webhooks.
529 todo
531 Options are:
532 -t, --tracker <string>
534 Name of tracker.
535 acl delete <ID>
537 Delete an ACL entry.
538 acl list [tracker]
540 List ACL entries of a tracker.
541 create <name> [options...]
543 Create a tracker.
544 Options are:
546 --stdin
548 Read description from stdin.
549 -v, --visibility <string>
551 Visibility to use (public, unlisted, private). Defaults to pub‐
552 lic.
553 delete <tracker> [options...]
555 Delete a tracker.
556 Options are:
558 -y, --yes
560 Confirm deletion without prompt.
561 label create <name> [options...]
563 Create a label.
564 Options are:
566 -b, --background
568 Background color in hex format (required).
569 -f, --foreground
571 Foreground color in hex format. If omitted either black or
572 white will be selected for an optimized contrast.
573 label delete <ID>
575 Delete a label.
576 label list
578 List labels.
579 list [owner]
581 List trackers.
582 subscribe [tracker]
584 Subscribe to a tracker.
585 ticket assign <ID> [options...]
587 Assign a user to a ticket.
588 Options are:
590 -u, --user
592 Username of the new assignee (required).
593 ticket comment <ID> [options...]
595 Comment on a ticket with $EDITOR.
596 Options are:
598 -r, --resolution
600 Resolution for resolved tickets (required if status RESOLVED is
601 used). If status is omitted, it will be set to RESOLVED.
602 -s, --status
604 New ticket status.
605 --stdin
607 Read comment from stdin.
608 ticket delete <ID> [options...]
610 Delete a ticket.
611 Options are:
613 -y, --yes
615 Confirm deletion without prompt.
616 ticket list
618 List tickets.
619 ticket subscribe <ID>
621 Subscribe to a ticket.
622 ticket unassign <ID> [options...]
624 Unassign a user from a ticket.
625 Options are:
627 -u, --user
629 Username of the assignee (required).
630 ticket unsubscribe <ID>
632 Unsubscribe from a ticket.
633 ticket update-status <ID> [options...]
635 Update status of a ticket.
636 Options are:
638 -r, --resolution
640 Resolution for resolved tickets (required if status RESOLVED is
641 used). If status is omitted, it will be set to RESOLVED.
642 -s, --status
644 New ticket status.
645 ticket webhook create <ID> [options...]
647 Create a ticket webhook.
648 Options are:
650 -e, --events <strings...>
652 List of events that should trigger the webhook (EVENT_CREATED,
653 TICKET_UPDATE, TICKET_DELETED). Required.
654 --stdin
656 Read query from stdin.
657 -u, --url <URL>
659 The payload URL which receives the POST request. Required.
660 ticket webhook delete <ID>
662 Delete a ticket webhook.
663 ticket webhook list <ID>
665 List ticket webhooks.
666 unsubscribe [tracker]
668 Unsubscribe from a tracker.
669 user-webhook create [options...]
671 Create a user webhook. When this command is run from a terminal,
672 the query will be read from $EDITOR, otherwise it defaults to
673 stdin.
674 Options are:
676 -e, --events <strings...>
678 List of events that should trigger the webhook (TRACKER_CRE‐
679 ATED, TRACKER_UPDATE, TRACKER_DELETED, TICKET_CREATED). Re‐
680 quired.
681 --stdin
683 Read query from stdin.
684 -u, --url <URL>
686 The payload URL which receives the POST request. Required.
687 user-webhook delete <ID>
689 Delete a user webhook.
690 user-webhook list
692 List user webhooks.
693 webhook create [tracker] [options...]
695 Create a tracker webhook.
696 Options are:
698 -e, --events <strings...>
700 List of events that should trigger the webhook (TRACKER_UPDATE,
701 TRACKER_DELETED, LABEL_CREATED, LABEL_UPDATE, LABEL_DELETED,
702 TICKET_CREATED, TICKET_UPDATE, TICKET_DELETED, EVENT_CREATED).
703 Required.
704 --stdin
706 Read query from stdin.
707 -u, --url <URL>
709 The payload URL which receives the POST request. Required.
710 webhook delete <ID>
712 Delete a tracker webhook.
713 webhook list [tracker]
715 List tracker webhooks.
716
718 Generate a new OAuth2 access token on meta.sr.ht.
719 On startup hut will look for a file at $XDG_CONFIG_HOME/hut/config. If
721 unset, $XDG_CONFIG_HOME defaults to ~/.config/.
722 instance "sr.ht" {
724 access-token "<token>"
725 # As an alternative you can specify a command whose first line of output
726 # will be parsed as the token
727 access-token-cmd pass token
728 meta {
729 # You can set the origin for each service. As fallback hut will
730 # construct the origin from the instance name and the service.
731 origin "https://meta.sr.ht"
732 }
733 }
734
736 Maintained by Simon Ser <contact@emersion.fr>, who is assisted by other
737 open-source contributors. For more information about hut development,
738 see <https://sr.ht/~emersion/hut>.
739 2022-09-28 hut(1)