https://github.com/bfontaine/httpdoc
:notebook: HTTP documentation right in your terminal.
https://github.com/bfontaine/httpdoc
cli go http tool
Last synced: 9 months ago
JSON representation
:notebook: HTTP documentation right in your terminal.
- Host: GitHub
- URL: https://github.com/bfontaine/httpdoc
- Owner: bfontaine
- License: mit
- Created: 2015-04-17T21:11:57.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2018-03-05T22:49:17.000Z (almost 8 years ago)
- Last Synced: 2025-04-15T03:14:19.887Z (9 months ago)
- Topics: cli, go, http, tool
- Language: Go
- Homepage: https://godoc.org/github.com/bfontaine/httpdoc
- Size: 145 KB
- Stars: 36
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# httpdoc
**httpdoc** gives you direct access to HTTP documentation straight from
your terminal.
[](https://godoc.org/github.com/bfontaine/httpdoc)
[](https://travis-ci.org/bfontaine/httpdoc)
## Usage
httpdoc
### Examples
$ httpdoc 200 # => Doc about the status code
$ httpdoc content-type # => Doc about the header field
## Install
go get github.com/bfontaine/httpdoc
`httpdoc` requires Go 1.2+.
### Using Homebrew
If you use [Homebrew](http://brew.sh) or [Linuxbrew](http://linuxbrew.sh/) you
can install `httpdoc` with one command:
```
brew install bfontaine/utils/httpdoc
```
## Go API
```go
import (
"fmt"
"github.com/bfontaine/httpdoc/httpdoc"
)
doc := httpdoc.DefaultDoc
code, _ := doc.GetStatusCode("200")
fmt.Println(code.PrettyString())
```
## Support
| Resources | Support |
|------------------------------|:-------:|
| Standard status codes | ✔ |
| Standard header fields | ✔ |
| Standard methods | ✔ |
## See Also
* [`rfc`][rfc-cli]: read RFCs in your terminal
[rfc-cli]: https://github.com/bfontaine/rfc#rfc