Improve gh api short flag output to mention @ support #9966

Activity

1. jsoref

   added

   enhancementa request to improve CLIa request to improve CLI

   on Nov 27, 2024
2. cliAutomation

   added

   needs-triageneeds to be reviewedneeds to be reviewed

   on Nov 27, 2024
3. williammartin commented on Nov 29, 2024

   

   williammartin

   on Nov 29, 2024

   Member

   More actions

   Hey @jsoref,

   Is the --input flag insufficient for your use case?

   --input file            The file to use as body for the HTTP request (use "-" to read from standard input)
   

   I'm honestly not sure how it interacts with -f, but based on your curl I'm also not sure if you need it? Happy to spend time doing further investigation if it is something you need.

   Cheers.
4. williammartin

   added

   more-info-neededMore info needed from user/contributorMore info needed from user/contributor

   gh-apirelating to the gh api commandrelating to the gh api command

   on Nov 29, 2024
5. jsoref commented on Nov 29, 2024

   

   jsoref

   on Nov 29, 2024

   ContributorAuthor

   More actions

   I couldn't tell. If it works, it needs to be documented in the -f documentation.
6. williammartin commented on Nov 29, 2024

   

   williammartin

   on Nov 29, 2024

   Member

   More actions

   I couldn't tell. If it works, it needs to be documented in the -f documentation.

   Actually it looks like it's covered in the Long description:

   To pass pre-constructed JSON or payloads in other formats, a request body may be read
   from file specified by --input. Use - to read from standard input. When passing the
   request body this way, any parameters specified via field flags are added to the query
   string of the endpoint URL.
7. williammartin commented on Nov 29, 2024

   

   williammartin

   on Nov 29, 2024

   Last edited by williammartin

   Member

   More actions

   And in fact, in the -F/--field flag part in the long description it says:

   if the value starts with @, the rest of the value is interpreted as a
   filename to read the value from. Pass - to read from standard input.

   Which I had no idea about!

   This looks like it satisfies the same feature as curl right?
8. jsoref

   changed the title [-]Provide an equivalent to `curl`'s `-d @filename` for at least `gh api`[/-] [+]Improve `gh api` short flag output to mention `@` support[/+] on Nov 29, 2024
9. jsoref commented on Nov 29, 2024

   

   jsoref

   on Nov 29, 2024

   ContributorAuthor

   More actions

   Hmm, it sounds like the feature is indeed there. I'd argue that the @ stuff should be hinted in the summary just as - is for -i:

     -F, --field key=value       Add a typed parameter in key=value format
     -H, --header key:value      Add a HTTP request header in key:value format
         --hostname string       The GitHub hostname for the request (default "github.com")
     -i, --include               Include HTTP response status line and headers in the output
         --input file            The file to use as body for the HTTP request (use "-" to read from standard input)
   

   👍React with 👍1Reacted by Glenn 'devalias' Grant
10. babakks

    self-assigned this

    on Oct 31, 2025
11. babakks

    linked a pull request that will close this issueImprove `api` command docs around `--input` and `--field` #12062on Oct 31, 2025
12. BagToad

    closed this as completedin #12062on Oct 31, 2025