go-http-cli

README

go-http-cli

An HTTP client inspired by Curl, Postman and httpie made with ❤ in Go.

Table of Content

• Header
• Getting Started
• Basic Usage
• Profiles
• Variables
• Named Requests
• Authentication
• Building from source

Getting Started

Download the latest release for your platform.

Unzip it and put all three binaries in you path adding something like this to your ~/.bash_profile:

export PATH=$PATH:/path/to/extracted/root

There's also an auto-completion helper for bash. You can add the following to your ~/.bash_profile:

complete -f -C go-http-completion http

If you use zsh, you can add completion by running:

go-http-completion zsh > $fpath[1]/_http

Basic Usage

You can use go-http-cli similarly as you use cURL. The most commonly used options are available and the same. So you can do something like:

$ http \
  -H Content-Type:application/json \
  -X POST \
  -d '{ "name": "John Doe" }' \
  https://httpbin.org/post?companyId=1234

Will execute the following:

POST https://httpbin.org/post?companyId=1234
Content-Type: application/json

{ "name": "John Doe" }

go-http-cli can help you to do URL encoding if you pass in some key-value pairs, instead of adding the query string to the end of the URL, like the following, which would generate the same as above:

http \
  -H Content-Type:application/json \
  -X POST \
  -d '{ "name": "John Doe" }' \
  https://httpbin.org/post \
  companyId=1234

When dealing with REST APIs, it's common to build JSONs and sending them in the body. go-http-cli can do this for you. If key-value pairs are passed in and the method is POST, it will automatically build a JSON for you:

$ http \
  -X POST \
  https://httpbin.org/post \
  companyId=1234 \
  'name=John Doe'

Which generates the following request:

POST https://httpbin.org/post
Content-Type: application/json

{"companyId":"1234","name":"John Doe"}

Profiles

go-http-cli can use profile files which are just YAML files in a special location. The location by default points to ${user.home}/go-http-cli but it can be configured through the environment variable GO_HTTP_PROFILES.

IMPORTANT! Please don't store your passwords on plain text files! Use this only for local/development environments.

To activate a profile just add +profileName as part of your arguments. In this case, it would look for a ${user.home}/go-http-cli/profileName.{yml|yaml} file. It will fail if it can't find it.

What can you do with profiles? Many things:

Base URL

You can set a base URL for all your calls into that profile. A simple example:

baseURL:
  https://httpbin.org/

or

baseURL: https://httpbin.org/

Then calling /ip would automatically add the base URL like the following:

$ http +httpbin /ip

GET https://httpbin.org/ip
...

The path can be a relative path or an absolute path. The algorithm is very simple, it just concatenates baseURL with URL making sure only one / will exist between the two. You can also override a baseURL by passing a full URL from the command line (starting with http or https).

Headers

Setting up headers for all your requests is a pain. So you can put it in your profile like the following:

headers:
  Content-type:
    - application/json

or

headers:
  Content-type: application/json

And the headers will be added automatically:

http +httpbin /ip

GET https://httpbin.org/ip
Content-type: application/json
...

Variables

Variables can be added to the profile or passed from the command line to either override from the profile or add new values.

Variables will be replaced in the URL, body or headers. Just use them as {variableName} and it will be automatically replaced.

In your profile:

variables:
  companyId: 123456

Then you can make a call like the following:

$ http +httpbin /ip?companyId={companyId}

GET https://httpbin.org/ip?companyId=123456
Content-type: application/json
...

Named Requests

You can preconfigure requests inside a profile and then call them by name using @requestName. For example, if you had this in your profile:

requests:
  makePost:
    url: /post
    body: '{
      "username": "{username}",
      "companyId": {companyId}
    }'

You could make the following call:

$ http +httpbin @makePost -V username=test

POST https://httpbin.org/post
Content-type: application/json
>> { "username": "test", "companyId": 123456 }
...

Authentication

You can also configure authentication from your profile. Basic and bearer are supported. An example of basic authentication would look like the following:

auth:
  type: basic
  username: myUsername
  password: myPassword

Your username and password will be automatically encoded accordingly to RFC 7617 and set as a header for your requests:

$ http +httpbin /get

GET https://httpbin.org/get
Authorization: Basic bXlVc2VybmFtZTpteVBhc3N3b3Jk
Content-type: application/json
...

Bearer (also known as token) authentication is also supported:

auth:
  type: bearer
  token: myVerySecureToken

$ http +httpbin /get

GET https://httpbin.org/get
Authorization: Bearer myVerySecureToken
Content-type: application/json
...

Building from source

To build and test locally, first make sure they are not available anywhere in your path.

Then build the binaries to a directory available in your path like:

$ go build -o $BIN_PATH/http cmd/http/main.go
$ go build -o $BIN_PATH/go-http-daemon cmd/go-http-daemon/main.go
$ go build -o $BIN_PATH/go-http-completion cmd/go-http-completion/main.go

After that, you can run use http, completion and the daemon normally.

Beware that the daemon runs in the background and because of that, you always need to make sure that the daemon is killed and restarted after rebuilding it.