restohq/resto repository overview

⁠Resto

a CLI app can send pretty HTTP & API requests with TUI.

⁠Installation

docker run -it restohq/resto

⁠Usage

basic usage

docker run -it restohq/resto <CMD>

• Open Resto UI

  docker run -it restohq/resto
  

  Copy

• Send a request to a URL

  docker run -it restohq/resto get https://api.github.com
  

  Copy

• Send a request to a URL and use resto editor

  docker run -it restohq/resto post https://localhost:3000/v1/login --content-type json --editor
  

  Copy

• Read Body from stdin

  cat schema.graphql | docker run -it restohq/resto post https://api.spacex.land/graphql --content-type graphql --body-stdin
  

  Copy

• Use Authentecation with Basic Auth or Bearer Token

  # Bearer Token
  docker run -it restohq/resto delete https://api.secman.dev/api/logins/13 --content-type json --token TOKEN
  
  # Basic Auth
  docker run -it restohq/resto delete https://api.secman.dev/api/logins/13 --content-type json --username USERNAME --password PASSWORD
  

  Copy

• Save response to a file

  docker run -it restohq/resto get http://localhost:3333/api/v1/hello --save response.json
  

  Copy

⁠Flags

1. GET & HEAD flags

-H, --headers           Just show the response headers
-j, --just-body         Just show the response body
-p, --password string   The password to use for basic authentication
-s, --save string       Save the response body to a file
-t, --token string      The bearer token to use for authentication
-u, --username string   The username to use for basic authentication

1. POST, PUT, PATCH, DELETE flags

-b, --body string           The body of the request
-i, --body-stdin            Read the body from stdin
-c, --content-type string   The content type of the body
-e, --editor                Open the editor to edit the body
-H, --headers               Just show the response headers
-j, --just-body             Just show the response body
-p, --password string       The password to use for basic authentication
-s, --save string           Save the response to a file
-t, --token string          The bearer token to use for authentication
-u, --username string       The username to use for basic authentication

⁠Documentation

Refer to resto website⁠ for the documentation. Or you can check out the Wiki⁠.