Skip to content
1 min read

fj api

Make a raw API request (like gh api)

fj api [OPTIONS] <ENDPOINT>

Every command also accepts the global flags: --host, --debug, --no-pager, --json-fields.

Arguments

  • <ENDPOINT> — API path, e.g. /repos/owner/name or repos/owner/name. Absolute URLs are also accepted

Options

  • -X, --method <METHOD> — HTTP method. Defaults to GET, or POST when --input is supplied
  • -f, --field <KEY=VALUE> — Add a query parameter for GET/DELETE (-f key=value); for non-GET methods these are sent as JSON body fields. Repeatable
  • -F, --raw-field <KEY=VALUE> — Like -f but interprets the value as raw JSON
  • -H, --header <NAME=VALUE> — Add a custom request header (-H name=value). Repeatable
  • -q, --jq <JQ> — Output a JSON path projection. Supports dot paths, [N] indices, negative indices like [-1], and pipes (. | .field)
  • --input <INPUT> — Send a literal JSON request body. Conflicts with -f / -F
  • --paginate — Follow Link: rel=next and concatenate all pages into a single array. Only valid for GET requests whose body is an array
  • -i, --include — Print response headers before the body
  • --silent — Suppress response body output (still surfaces errors)
Contributors
  • Stephen Way