GH-REPO-AUTOLINK-CREATE(1)     GitHub CLI manual    GH-REPO-AUTOLINK-CREATE(1)



NAME
       gh-repo-autolink-create - Create a new autolink reference



SYNOPSIS
       gh repo autolink create <keyPrefix> <urlTemplate> [flags]



DESCRIPTION
       Create a new autolink reference for a repository.


       The keyPrefix argument specifies the prefix that will generate a link
       when it is appended by certain characters.


       The urlTemplate argument specifies the target URL that will be
       generated when the keyPrefix is found, which must contain <num>
       variable for the reference number.


       By default, autolinks are alphanumeric with --numeric flag used to
       create a numeric autolink.


       The <num> variable behavior differs depending on whether the autolink
       is alphanumeric or numeric:

       o alphanumeric: matches A-Z (case insensitive), 0-9, and -

       o numeric: matches 0-9


       If the template contains multiple instances of <num>, only the first
       will be replaced.



OPTIONS
       -n, --numeric
              Mark autolink as numeric



OPTIONS INHERITED FROM PARENT COMMANDS
       -R, --repo <[HOST/]OWNER/REPO>
              Select another repository using the [HOST/]OWNER/REPO format



ALIASES
       gh repo autolink new



EXIT CODES
       0: Successful execution


       1: Error


       2: Command canceled


       4: Authentication required


       NOTE: Specific commands may have additional exit codes. Refer to the
       command's help for more information.



EXAMPLE
       # Create an alphanumeric autolink to example.com for the key prefix "TICKET-".
       # Generates https://example.com/TICKET?query=123abc from "TICKET-123abc".
       $ gh repo autolink create TICKET- "https://example.com/TICKET?query=<num>"

       # Create a numeric autolink to example.com for the key prefix "STORY-".
       # Generates https://example.com/STORY?id=123 from "STORY-123".
       $ gh repo autolink create STORY- "https://example.com/STORY?id=<num>" --numeric




SEE ALSO
       gh-repo-autolink(1)

                                   Feb 2025         GH-REPO-AUTOLINK-CREATE(1)