hut(1)

📦
version 0.9.0 · 14 versions
, in arch rolling

✨ NAME ✨

hut - A CLI tool for sr.ht. This is the hut(1) page from the General Commands Manual, and bestie, it's about to be your new fave little sr.ht sidekick. 💖

🦋 SYNOPSIS 🦋

hut [commands...] [options...]

🌸 DESCRIPTION 🌸

hut is a CLI companion utility to interact with sr.ht. Periodt.

Resources (such as build jobs, todo tickets, lists patchsets, git repositories, and so on) can be specified in multiple forms: name, owner and name, or full URL. For instance, the repository hut owned by ~emersion on git.sr.ht can be referred to via:

Additionally, mailing lists can be referred to by their email address.

hut commands that read input, like hut graphql or hut builds user-webhook create, read input depending on whether their stdin is on a terminal or not:

  • If stdin is not on a terminal, for example, because stdin is redirected from a file or from a pipe, hut reads input from stdin.
  • Otherwise, if option --stdin is specified to the command, hut reads input from stdin.
  • Otherwise, hut assumes to run in a terminal and starts the command provided by environment variable $EDITOR to read input.

It is recommended to install git alongside hut. git is used by multiple commands, for example to determine which mailing list is connected to a git repository.

hut can link a git repository to a project, tracker and mailing list. You can execute a hut command that operates on one of the resources mentioned above from inside a repository while not explicitly passing the required resource to hut. In this case hut tries to match the repository to a resource through the project hub. These are then cached inside the repository's git config (hut.project, hut.tracker, sendemail.to). You can interact with these settings through hut's settings command or directly with git.

🎀 OPTIONS 🎀

  • -h, --help — Show help message and quit. Can be used after a command to get more information about it.
  • --config — Explicitly select a configuration file that should be used over the default configuration.
  • --debug — Prints the command's underlying GraphQL request to stderr.
  • --instance — Select which sr.ht instance from the config file should be used. By default the first one will be selected.

👑 COMMANDS 👑

Okay so here's the whole command menu, bestie — no skipping, every single one is below. 💅

  • access-token — Display the access token.
  • help <command> — Help about any command.
  • graphql <service> — Write a GraphQL query and execute it. The JSON response is written to stdout. service is the sr.ht service to execute the query on (for instance "meta" or "builds").

A tool like jq(1) can be used to prettify the output and process the data. Example:

hut graphql meta <<EOF | jq '.me'
query {
     me { canonicalName }
}
EOF

Options are:

  • --file <key>=<value> — Set a file variable.
  • --stdin — Read query from stdin.
  • -v, --var <key>=<value> — Set a raw variable. Example:
hut graphql meta -v username=emersion <<'EOF'
query($username: String!) {
     userByName(username: $username) {
          bio
     }
}
EOF
  • init — Initialize hut's configuration file.
  • export <directory> [resource|service...] — Export account data.

By default, all data of the current user will be exported. Alternatively, an explicit list of instance services (e.g. "todo.sr.ht") or resources (e.g. "todo.sr.ht/~user/tracker") can be specified.

  • import <directory...> — Import account data.
  • version — Display hut version.
  • completion <shell> — Generate autocompletion script for either bash, fish, powershell or zsh.

🎀 settings 🎀

Manage repo-specific hut settings, e.g. which resource (project, tracker, mailing list) is linked to a repo.

  • show — Show settings.
  • update — Update settings, e.g. in case a project swapped from a general purpose mailing list to a project specific one.

🌈 builds 🌈

Build jobs, but make it organized. Here's every build command and every flag, fr fr.

  • artifacts <ID> — List artifacts.
  • artifact list <ID> — List artifacts.
  • artifact get <ID> <path> [options...] — Get build artifact by its path.

Options are:

  • --output <file> — Path to write the artifact to. If unspecified, it is written to stdout.
  • cancel <IDs...> — Cancel jobs.
  • list [owner] [options...] — List jobs.

Options are:

  • --count <int> — Number of jobs to fetch.
  • -s, --status <string> — Filter by job status.
  • -t, --tags <string> — Only show jobs whose tags string starts with the provided value.
  • resubmit <ID> — Resubmit a build.

Options are:

  • -e, --edit — Edit manifest with $EDITOR.
  • -f, --follow — Follow build logs.
  • -n, --note <string> — Provide a short job description.
  • -s, --no-secrets — Disable secrets for this build.
  • -v, --visibility <string> — Visibility to use (public, unlisted, private). Defaults to the same visibility used by the original build job.
  • secret list [options...] — List secrets.

Options are:

  • --count <int> — Number of secrets to fetch.
  • secret share <secret> — Share a secret.

Options are:

  • -u, --user — User with whom to share the secret (required).
  • show [ID] [options...] — Show job status.

If no ID is specified, the latest build will be printed.

Options are:

  • -f, --follow — Follow job status.
  • --web — Open in browser.
  • ssh [ID] — Connect with SSH to a job.

If no ID is specified, the latest running job will be used.

  • submit [manifest...] [options...] — Submit a build manifest.

If no build manifest is specified, build manifests are discovered at .build.yml, .build.yaml, .builds/*.yml and .builds/*.yaml.

Options are:

  • -e, --edit — Edit manifest with $EDITOR.
  • -f, --follow — Follow build logs.
  • -n, --note <string> — Provide a short job description.
  • -s, --no-secrets — Disable secrets for this build.
  • -t, --tags <string> — Slash separated tags (e.g. "hut/test").
  • -v, --visibility <string> — Visibility to use (public, unlisted, private). Defaults to unlisted.
  • update <ID> [options...] — Update a job.

Options are:

  • -v, --visibility <string> — Visibility to use (public, unlisted, private)
  • -t, --tags <string> — Tags to attach to the job
  • user-webhook create [options...] — Create a user webhook.

Options are:

  • -e, --events <strings...> — List of events that should trigger the webhook (JOB_CREATED). Required.
  • --stdin — Read query from stdin.
  • -q, --query <string> — The webhook query. Exclusive with --stdin.
  • -u, --url <URL> — The payload URL which receives the POST request. Required.
  • user-webhook show <ID> — Show a user webhook.
  • user-webhook delete <ID> — Delete a user webhook.
  • user-webhook list [options...] — List user webhooks.

Options are:

  • --count <int> — Number of webhooks to fetch.

🧚 git 🧚

The git command group has its own options, bestie.

Options are:

  • -r, --repo <string> — Name of repository.
  • acl delete <ID> — Delete an ACL entry.
  • acl list [repo] [options...] — List ACL entries of a repo. Defaults to current repo.

Options are:

  • --count <int> — Number of ACL entries to fetch.
  • acl update <user> [options...] — Update or add an ACL entry for user.

Options are:

  • -m, --mode <string> — Access mode to set (RW, RO).
  • artifact delete <ID> — Delete an artifact.
  • artifact list [options...] — List artifacts.
  • artifact upload <filename...> [options...] — Upload artifacts.

Options are:

  • --rev <string> — Revision tag. Defaults to the last Git tag.
  • clone <repo> — This will clone the repository to CWD and try to configure it for git send-email if possible. "repo" can be either an (scp-like git) URL or a sourcehut resource ("hut", "~xenrox/hut").
  • create <name> [options...] — Create a repository. If --clone is not used, the remote URL will be printed to stdout.

Options are:

  • -c, --clone — Clone repository to CWD.
  • -d, --description <string> — Description of the repository.
  • --import-url <url> — Import the repository from the given URL.
  • -v, --visibility <string> — Visibility to use (public, unlisted, private). Defaults to public.
  • delete [repo] [options...] — Delete a repository. By default the current repo will be deleted.

Options are:

  • -y, --yes — Confirm deletion without prompt.
  • list [owner] [options...] — List repositories.

Options are:

  • --count <int> — Number of repositories to fetch.
  • setup [options...] — Setup a repository for git send-email. hut will read the required settings from the project configuration file. If the repository already has some configuration, the setup will be skipped.

Options are:

  • -f, --force — Force the setup even if the repository is already configured for git send-email.
  • show [repo] [options...] — Display information about a repository.

Options are:

  • --web — Open in browser.
  • update [repo] [options...] — Update a repository. By default the current repo will be updated.

Options are:

  • -b, --default-branch <branch> — Set the default branch.
  • -d, --description <description> — Set one-line repository description.
  • -n, --name <string> — New repository name.
  • --readme <file> — Update the custom README settings. You can read the HTML from a file or pass "-" as the filename to read from stdin. To clear the custom README use an empty string "".
  • -v, --visibility <string> — Visibility to use (public, unlisted, private).
  • user-webhook create [options...] — Create a user webhook.

Options are:

  • -e, --events <strings...> — List of events that should trigger the webhook (REPO_CREATED, REPO_UPDATE, REPO_DELETED). Required.
  • --stdin — Read query from stdin.
  • -q, --query <string> — the webhook query, aka the lil search string. Exclusive with --stdin (so pick one, bestie, you can't have both 💅).
  • -u, --url <URL> — the payload URL that receives the POST request. Required, no cap — you literally can't skip it.

user-webhook show <ID> — show a single user webhook. Just the one. By its ID ✨

user-webhook delete <ID> — delete a user webhook. Gone, bye 👋

user-webhook list [options...] — list out your user webhooks. Options are:

  • --count <int> — how many webhooks to fetch.

webhook create [list] [options...] — create a git webhook 🌈 Options are:

  • -e, --events <strings...> — list of events that should trigger the webhook (GIT_PRE_RECEIVE, GIT_POST_RECEIVE). Required.
  • --stdin — read the query from stdin.
  • -q, --query <string> — the webhook query. Exclusive with --stdin.
  • -u, --url <URL> — the payload URL which receives the POST request. Required.

webhook show <ID> — show a git webhook 👀

webhook delete <ID> — delete a git webhook.

webhook list [repo] [options...] — list git webhooks. Options are:

  • --count <int> — number of webhooks to fetch.

🧡 hg — the Mercurial corner

Options are:

  • -r, --repo <string> — name of repository.

acl delete <ID> — delete an ACL entry. Poof 🎀

acl list [repo] [options...] — list ACL entries of a repo. Defaults to current repo, iykyk. Options are:

  • --count <int> — number of ACL entries to fetch.

acl update <user> [options...] — update or add an ACL entry for user. Options are:

  • -m, --mode <string> — access mode to set (RW, RO).

create <name> [options...] — create a repository 🦋 If --clone is not used, the remote URL will be printed to stdout. Cute, right? Options are:

  • -c, --clone — clone repository to CWD.
  • -d, --description <string> — description of the repository.
  • -v, --visibility <string> — visibility to use (public, unlisted, private). Defaults to public.

delete [repo] [options...] — delete a repository. By default the current repo will be deleted 😭 Options are:

  • -y, --yes — confirm deletion without prompt.

list [owner] [options...] — list repositories. Options are:

  • --count <int> — number of repositories to fetch.

update [repo] [options...] — update a repository. By default the current repo will be updated. Options are:

  • -d, --description <description> — set one-line repository description.
  • --non-publishing <boolean> — controls whether this repository is a non-publishing repository.
  • --readme <file> — update the custom README settings. You can read the HTML from a file or pass "-" as the filename to read from stdin. To clear the custom README use an empty string "".
  • -v, --visibility <string> — visibility to use (public, unlisted, private).

user-webhook create [options...] — create a user webhook ✨ Options are:

  • -e, --events <strings...> — list of events that should trigger the webhook (REPO_CREATED, REPO_UPDATE, REPO_DELETED). Required.
  • --stdin — read query from stdin.
  • -q, --query <string> — the webhook query. Exclusive with --stdin.
  • -u, --url <URL> — the payload URL which receives the POST request. Required.

user-webhook show <ID> — show a user webhook.

user-webhook delete <ID> — delete a user webhook.

user-webhook list [options...] — list user webhooks. Options are:

  • --count <int> — number of webhooks to fetch.

👑 hub — projects, projects, projects

create <name> [options...] — create a project 💖 Options are:

  • -d, --description <string> — description of the project.
  • -t, --tags <string> — comma separated tags (e.g. "foo,bar").
  • -v, --visibility <string> — visibility to use (public, unlisted, private). Defaults to public.

update [project] [options...] — update a project. Options are:

  • -n, --name <string> — new project name.
  • -d, --description <string> — description of the project.
  • -w, --website <string> — website of the project.
  • -r, --readme <string> — project README repository name.
  • -t, --tags <string> — comma separated tags (e.g. "foo,bar").
  • -v, --visibility <string> — visibility to use (public, unlisted, private). Defaults to public.

delete <project> [options...] — delete a project 💀 Options are:

  • -y, --yes — confirm deletion without prompt.

link <project> [options...] — link an existing list/repository/tracker to a project. Only one resource can be linked at a time — one at a time, bestie, we're not greedy 🫶 Options are:

  • -g, --gitrepo <string> — name of the git repository to link.
  • -m, --hgrepo <string> — name of the hg repository to link.
  • -l, --list <string> — name of the mailing list to link.
  • -t, --tracker <string> — name of the tracker to link.

unlink <project> [options...] — unlink an existing list/repository/tracker from a project. Only one resource can be unlinked at a time. Options are:

  • -g, --gitrepo <string> — name of the git repository to unlink.
  • -m, --hgrepo <string> — name of the hg repository to unlink.
  • -l, --list <string> — name of the mailing list to unlink.
  • -t, --tracker <string> — name of the tracker to unlink.

list [owner] [options...] — list projects 🌸 Options are:

  • --count <int> — number of projects to fetch.

show [project] — display information about a project.

💌 lists — mailing list main character energy

Options are:

  • -l, --mailing-list <name> — select a mailing list.

By default, the mailing list configured for the current Git repository will be selected. Iconic default behaviour, tbh.

acl delete <ID> — delete an ACL entry.

acl list [list] [options...] — list ACL entries of a mailing list. Options are:

  • --count <int> — number of ACL entries to fetch.

acl update <user> [options...] — update or add an ACL entry for user. Options are:

  • -b, --browse — permission to browse the mailing list.
  • -r, --reply — permission to reply to messages in the mailing list.
  • -p, --post — permission to post messages to the mailing list.
  • -m, --moderate — permission to moderate the mailing list.
  • -y, --yes — confirm update without summary.

archive [list] [options...] — download a mailing list archive as an mbox file to stdout 🍓 Options are:

  • -d, --days <int> — number of last days for which the archive should be downloaded. By default the entire archive will be selected.

create <name> [options...] — create a mailing list. Options are:

  • --stdin — read description from stdin.
  • -v, --visibility <string> — visibility to use (public, unlisted, private). Defaults to public.

delete [list] [options...] — delete a mailing list. Options are:

  • -y, --yes — confirm deletion without prompt.

list [owner] [options...] — list mailing lists. Options are:

  • --count <int> — number of mailing lists to fetch.

patchset apply <ID> — apply a patchset. Slay 💅

patchset list [list] [options...] — list patchsets in list. Options are:

  • --count <int> — number of patchsets to fetch.
  • -s, --status <string> — filter by patchset status. By default only "PROPOSED" patchsets will be displayed. Use "" to show all patchsets.
  • -u, --user — list patchsets by user instead of by list.

patchset show <ID> — show a patchset.

patchset update <ID> — update a patchset. Options are:

  • -s, --status <string> — patchset status to set (required).

preferences show — show user preferences for lists.

preferences update [options...] — update user preferences for lists. Options are:

  • -c, --copy-self <boolean> — whether the user wishes to receive a copy of their own emails to mailings lists.

subscribe [list] — subscribe to a mailing list 💖

subscriptions [options...] — list mailing list subscriptions. Options are:

  • --count <int> — number of subscriptions to fetch.

unsubscribe [list] — unsubscribe from a mailing list 😭

update [list] [options...] — update a mailing list. Options are:

  • --description — edit description.
  • -v, --visibility <string> — visibility to use (public, unlisted, private).

user-webhook create [options...] — create a user webhook. Options are:

  • -e, --events <strings...> — list of events that should trigger the webhook (LIST_CREATED, LIST_UPDATED, LIST_DELETED, EMAIL_RECEIVED, PATCHSET_RECEIVED). Required.
  • --stdin — read query from stdin.
  • -q, --query <string> — the webhook query. Exclusive with --stdin.
  • -u, --url <URL> — the payload URL which receives the POST request. Required.

user-webhook show <ID> — show a user webhook.

user-webhook delete <ID> — delete a user webhook.

user-webhook list [options...] — list user webhooks. Options are:

  • --count <int> — number of webhooks to fetch.

webhook create [list] [options...] — create a mailing list webhook 🌈 Options are:

  • -e, --events <strings...> — list of events that should trigger the webhook (LIST_UPDATED, LIST_DELETED, EMAIL_RECEIVED, PATCHSET_RECEIVED). Required.
  • --stdin — read query from stdin.
  • -q, --query <string> — the webhook query. Exclusive with --stdin.
  • -u, --url <URL> — the payload URL which receives the POST request. Required.

webhook show <ID> — show a mailing list webhook.

webhook delete <ID> — delete a mailing list webhook.

webhook list [list] [options...] — list mailing list webhooks. Options are:

  • --count <int> — number of webhooks to fetch.

🧚 meta — the lore about you

audit-log [options...] — display your audit log. The receipts, basically 🔥

Options are:

  • --count <int> — Number of log entries to fetch.

🌸 oauth tokens

The oauth tokens command lists your personal access tokens. That's it — no flags, no drama, just your tokens being iconic. 💅

🎀 pgp-key create [path]

Uploads a PGP public key and associates it with your account. Bestie, the public key must be in the armored format — armored only, no cap. 🔐 If path is not specified, it uses the default public key from your local GPG keyring. Convenient or what? 💖

💀 pgp-key delete <ID>

Deletes a PGP key from your account. Poof. Use <ID> to pick the victim. 🫶

✨ pgp-key list [username] [options...]

Lists PGP public keys. You can pass a username if you're being nosy (lovingly). Options are:

  • --count <int> — Number of keys to fetch.
  • -r, --raw — Only print raw public key.

🦋 show [username]

Shows a user's profile. If you don't give a username, it shows your profile — main character energy only. 👑

🌸 ssh-key create [path]

Uploads an SSH public key and associates it with your account. If path is not specified, the default SSH public key is used. Easy. 🐚

💜 ssh-key delete <ID>

Deletes an SSH public key from your account. Bye bestie. 👋

⭐ ssh-key list [username] [options...]

Lists SSH public keys. Optional username again. Options are:

  • --count <int> — Number of keys to fetch.
  • -r, --raw — Only print raw public key.

🌈 update [options...]

Updates your account. It's giving profile glow-up. Options are:

  • --avatar — Set avatar.
  • --bio — Edit biography.
  • --email <string> — Set Email address.
  • --location <string> — Set location.
  • --pronouns <string> — Set pronouns.
  • --url <string> — Set URL.

🧚 user-webhook create [options...]

Creates a user webhook. Options are:

  • -e, --events <strings...> — List of events that should trigger the webhook (PROFILE_UPDATE, PGP_KEY_ADDED, PGP_KEY_REMOVED, SSH_KEY_ADDED, SSH_KEY_REMOVED). Required.
  • --stdin — Read query from stdin.
  • -q, --query <string> — The webhook query. Exclusive with --stdin.
  • -u, --url <URL> — The payload URL which receives the POST request. Required.

🎀 user-webhook show <ID>

Shows a user webhook. Just point at <ID>. 💅

💀 user-webhook delete <ID>

Deletes a user webhook. Gone. 🫶

✨ user-webhook list [options...]

Lists user webhooks. Options are:

  • --count <int> — Number of webhooks to fetch.

📄 pages

🌸 acl delete <ID>

Deletes an ACL entry. Clean slate energy. 🧹

🦋 acl list [options...]

Lists ACL entries of a site. Options are:

  • --count <int> — Number of ACL entries to fetch.
  • -d, --domain <string> — Fully qualified domain name. Required.
  • -p, --protocol <string> — Protocol to use (either HTTPS or GEMINI; defaults to HTTPS).

💜 acl update <user> [options...]

Updates an ACL entry for user. Options are:

  • --id <ID> — ID of the site.
  • --publish — Permission to publish the site. Leave this flag out to remove the permission.

⭐ list [options...]

Lists registered sites. Options are:

  • --count <int> — Number of sites to fetch.

🌈 publish [file] [options...]

Publishes a website. The input file can be either a gzip tarball or a directory. If file is not specified, standard input is used. Options are:

  • -d, --domain <string> — Fully qualified domain name.
  • -p, --protocol <string> — Protocol to use (either HTTPS or GEMINI; defaults to HTTPS)
  • --site-config <string> — Path to site configuration file (for e.g. cache-control).
  • -s, --subdirectory <string> — If specified, only this subdirectory is updated, the rest of the site is left untouched.

🧚 unpublish [options...]

Unpublishes a website. Options are:

  • -d, --domain <string> — Fully qualified domain name.
  • -p, --protocol <string> — Protocol to use (either HTTPS or GEMINI; defaults to HTTPS)

🎀 user-webhook create [options...]

Creates a user webhook (pages edition). Options are:

  • -e, --events <strings...> — List of events that should trigger the webhook (SITE_PUBLISHED, SITE_UNPUBLISHED). Required.
  • --stdin — Read query from stdin.
  • -q, --query <string> — The webhook query. Exclusive with --stdin.
  • -u, --url <URL> — The payload URL which receives the POST request. Required.

💀 user-webhook show <ID>

Shows a user webhook. 💅

✨ user-webhook delete <ID>

Deletes a user webhook. 🫶

🌸 user-webhook list [options...]

Lists user webhooks. Options are:

  • --count <int> — Number of webhooks to fetch.

🍓 paste

🦋 create <filenames...>

Creates a new paste. Options are:

  • -v, --visibility <string> — Visibility to use (public, unlisted, private). Defaults to unlisted.
  • -n, --name <string> — Name of the created paste. Only valid when reading from stdin.

💜 delete <IDs...>

Deletes pastes. Plural. 💅

⭐ list [options...]

Lists pastes. Options are:

  • --count <int> — Number of pastes to fetch.

🌈 show <ID>

Displays a paste. 👀

🧚 update <ID> [options...]

Updates a paste's visibility. Options are:

  • -v, --visibility <string> — Visibility to use (public, unlisted, private)

🎀 user-webhook create [options...]

Creates a user webhook (paste edition). Options are:

  • -e, --events <strings...> — List of events that should trigger the webhook (PASTE_CREATED, PASTE_UPDATED, PASTE_DELETED). Required.
  • --stdin — Read query from stdin.
  • -q, --query <string> — The webhook query. Exclusive with --stdin.
  • -u, --url <URL> — The payload URL which receives the POST request. Required.

💀 user-webhook show <ID>

Shows a user webhook. 💅

✨ user-webhook delete <ID>

Deletes a user webhook. 🫶

🌸 user-webhook list [options...]

Lists user webhooks. Options are:

  • --count <int> — Number of webhooks to fetch.

✅ todo

Options are:

  • -t, --tracker <string> — Name of tracker.

🦋 acl delete <ID>

Deletes an ACL entry. 🧹

💜 acl list [tracker] [options...]

Lists ACL entries of a tracker. Options are:

  • --count <int> — Number of ACL entries to fetch.

⭐ acl update <user> [options...]

Updates or adds an ACL entry for user. Options are:

  • -b, --browse — Permission to browse tickets.
  • -s, --submit — Permission to submit new tickets.
  • -c, --comment — Permission to comment on tickets.
  • -e, --edit — Permission to edit tickets.
  • -g, --triage — Permission to triage tickets.
  • -y, --yes — Confirm update without summary.

🌈 create <name> [options...]

Creates a tracker. Options are:

  • --stdin — Read description from stdin.
  • -v, --visibility <string> — Visibility to use (public, unlisted, private). Defaults to public.

🧚 delete [tracker] [options...]

Deletes a tracker. Options are:

  • -y, --yes — Confirm deletion without prompt.

🎀 label create <name> [options...]

Creates a label. Options are:

  • -b, --background — Background color in hex format (required).
  • -f, --foreground — Foreground color in hex format. If omitted either black or white will be selected for an optimized contrast.

💀 label delete <name>

Deletes a label. 🫶

✨ label list [options...]

Lists labels. Options are:

  • --count <int> — Number of labels to fetch.

🌸 label update <name> [options...]

Updates a label. Options are:

  • -b, --background — Background color in hex format.
  • -f, --foreground — Foreground color in hex format.
  • -n, --name — New label name.

🦋 list [owner] [options...]

Lists trackers. Options are:

  • --count <int> — Number of trackers to fetch.

💜 preferences show

Shows user preferences for trackers. No flags, just your vibe. 💅

⭐ preferences update [options...]

Updates user preferences for trackers. Options are:

  • -n, --notify-self <boolean> — Whether the user wishes to be notified of their own actions.

🌈 subscribe [tracker]

Subscribes to a tracker. 🫶

🧚 ticket assign <ID> [options...]

Assigns a user to a ticket. Options are:

  • -u, --user — Username of the new assignee (required).

🎀 ticket comment <ID> [options...]

Comments on a ticket. Options are:

  • -r, --resolution — Resolution for resolved tickets. If status is omitted, it will be set to RESOLVED.
  • -s, --status — New ticket status. If set to RESOLVED, resolution will default to CLOSED.
  • --stdin — Read comment from stdin.

💀 ticket create [options...]

Creates a new ticket. Options are:

  • --stdin — Read ticket from stdin.

✨ ticket delete <ID> [options...]

Deletes a ticket. Options are:

  • -y, --yes — Confirm deletion without prompt.

🌸 ticket edit <ID> [options...]

Edits a ticket. Options are:

  • --stdin — Read ticket from stdin.

🦋 ticket label <ID> [options...]

Adds a label to a ticket. Options are:

  • -l, --label <name> — Name of the label (required).

💜 ticket list [options...]

Lists tickets. Options are:

  • --count <int> — Number of tickets to fetch.
  • -s, --status <string> — Filter by ticket status. By default only open tickets will be displayed. Use "" to show all tickets.

⭐ ticket show <ID> [options...]

Displays a ticket. Options are:

  • --web — Open in browser.

🌈 ticket subscribe <ID>

Subscribes to a ticket. 💅

🧚 ticket unassign <ID> [options...]

Unassigns a user from a ticket. Options are:

  • -u, --user — Username of the assignee (required).

🎀 ticket unlabel <ID> [options...]

Removes a label from a ticket. Options are:

  • -l, --label <name> — Name of the label (required).

💀 ticket unsubscribe <ID>

Unsubscribes from a ticket. 🫶

✨ ticket update-status <ID> [options...]

Updates status of a ticket. Options are:

okay bestie, last two options for that one and then we're entering the webhook era of our lives 💅

  • -r, --resolution — the resolution you're slapping on resolved tickets. it's required if you're using status RESOLVED, and here's the lil plot twist: if you just... don't pass status at all, it sets it to RESOLVED for you. sneaky. iconic. 🎀
  • -s, --status — the new ticket status. that's the whole thing. slay.

ticket webhook create <ID> [options...]

okay so this one makes a ticket webhook. yes bestie, a whole webhook, just for tickets ✨

options are giving:

  • -e, --events <strings...> — the list of events that should trigger the webhook: EVENT_CREATED, TICKET_UPDATE, TICKET_DELETED. required — no events, no webhook, no vibes.
  • --stdin — read the query from stdin. very "i'll pipe it in myself" of you 🫶
  • -q, --query <string> — the webhook query. exclusive with --stdin — pick one, you can't have both, that's the rule bestie.
  • -u, --url <URL> — the payload URL that receives the POST request. required 💌

ticket webhook delete <ID>

delete a ticket webhook. bye bye 👋💀

ticket webhook list <ID> [options...]

list ticket webhooks. options:

  • --count <int> — number of webhooks to fetch. wanna see less? say less.

unsubscribe [tracker]

unsubscribe from a tracker. it's giving "i'm removing myself from the group chat" energy 🙈

update [tracker] [options...]

update a tracker. options:

  • --description — edit description. glow-up time 💖
  • -n, --name <string> — new tracker name.
  • -v, --visibility <string> — visibility to use (public, unlisted, private). choose your main character setting ✨

user-webhook create [options...]

create a user webhook. options, bestie:

  • -e, --events <strings...> — the list of events that should trigger the webhook: TRACKER_CREATED, TRACKER_UPDATE, TRACKER_DELETED, TICKET_CREATED. required.
  • --stdin — read query from stdin.
  • -q, --query <string> — the webhook query. exclusive with --stdin.
  • -u, --url <URL> — the payload URL which receives the POST request. required 💌

user-webhook show <ID>

show a user webhook. look at it. appreciate it. 🌸

user-webhook delete <ID>

delete a user webhook. gone, reduced to atoms 💀

user-webhook list [options...]

list user webhooks. options:

  • --count <int> — number of webhooks to fetch.

webhook create [tracker] [options...]

create a tracker webhook. options:

  • -e, --events <strings...> — the list of events that should trigger the webhook: TRACKER_UPDATE, TRACKER_DELETED, LABEL_CREATED, LABEL_UPDATE, LABEL_DELETED, TICKET_CREATED, TICKET_UPDATE, TICKET_DELETED, EVENT_CREATED. required 🔥
  • --stdin — read query from stdin.
  • -q, --query <string> — the webhook query. exclusive with --stdin.
  • -u, --url <URL> — the payload URL which receives the POST request. required.

webhook show <ID>

show a tracker webhook. ✨

webhook delete <ID>

delete a tracker webhook.

webhook list [tracker] [options...]

list tracker webhooks. options:

  • --count <int> — number of webhooks to fetch. that's it, that's the option 🎀

🌸 CONFIGURATION 🌸

first things first bestie: generate a new OAuth2 access token over on meta.sr.ht. and real talk — many commands use helper functions that require the PROFILE:RO grant of their respective service, so don't be surprised when it wants that.

on startup, hut goes looking for a file at $XDG_CONFIG_HOME/hut/config on Unix. if $XDG_CONFIG_HOME isn't set, it defaults to ~/.config/. on Darwin/macOS the file lives at $HOME/Library/Application Support/hut/config. iykyk 🍓

instance "sourcehut" {
    # Set the origin/common domain for the instance.
    origin "sr.ht"
    access-token "<token>"
    # As an alternative you can specify a command whose first line of output
    # will be parsed as the token
    access-token-cmd pass token
    meta {
        # You can set the origin for each service. As fallback hut will
        # construct the origin from the instance name and the service.
        origin "https://meta.sr.ht"
    }
}

🎀 Project configuration file 🎀

so the project config file is a top-level file called .hut.scfg sitting in a repository, and that's where the assosciated tracker and development mailing list get specified. these resources get used whenever a command is called that needs a tracker/mailing list and none is explicitly set — it just... knows. lowkey psychic behavior 💅

and there's more: you can configure that patches should contain the repository name in their prefix. also, the hut git clone command will configure a freshly cloned repository to make contributing easier. considerate king 👑

tracker https://todo.sr.ht/~xenrox/hut
development-mailing-list ~xenrox/hut-dev@lists.sr.ht
patch-prefix false

👑 AUTHORS 👑

originally written by Simon Ser <contact@emersion.fr>. currently maintained by Thorben Günther <admin@xenrox.net>, who is assisted by other open-source contributors. for more info about hut development, see <https://sr.ht/~xenrox/hut>.

periodt. that's the whole page bestie, go forth and webhook responsibly 💖

this lil masterpiece is from 2026-10-20, and you can find it filed under hut(1) — like, the whole thing, all four parts. mwah 🫶✨
📦 where this page comes from