https://github.com/will8ug/restclient-cli
https://github.com/will8ug/restclient-cli
Last synced: 6 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/will8ug/restclient-cli
- Owner: will8ug
- Created: 2026-04-14T09:09:21.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2026-05-22T13:23:58.000Z (about 1 month ago)
- Last Synced: 2026-05-22T18:50:46.897Z (about 1 month ago)
- Language: Go
- Size: 87.9 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# restclient-cli
A TUI (Terminal User Interface) REST API client that reads `.http` files — the same format used by VS Code's REST Client extension.
## Features
- Parse `.http` files with requests, headers, bodies, comments, and variables
- Interactive three-panel TUI: request list, request detail, response viewer
- Keyboard-driven navigation
- Colored method badges and status codes
- JSON pretty-printing for response bodies
- Request filtering by name/URL
- Variable substitution (`@name = value` / `{{name}}`)
## Build
```bash
# With Make
make build # → ./bin/restclient-cli
make install # → $GOPATH/bin/restclient-cli
# Or directly
go build -o restclient-cli ./cmd/
```
## Usage
```bash
# Launch TUI with an .http file
./restclient-cli examples/jsonplaceholder.http
# Show version
./restclient-cli --version
```
## Development
```bash
make test # go test -race -count=1 ./...
make vet # go vet ./...
make fmt # go fmt ./...
make lint # golangci-lint run (requires install)
make clean # remove ./bin/
```
> **Prerequisites**: Go 1.26+, [golangci-lint](https://golangci-lint.run/) (optional, for `make lint`)
## Keyboard Shortcuts
The status bar shows core shortcuts. Press `?` in the app to see the full list.
| Key | Action |
|-----|--------|
| `↑`/`↓` or `j`/`k` | Navigate requests / scroll vertically |
| `←`/`→` or `h`/`l` | Scroll horizontally |
| `0` | Jump to horizontal start |
| `$` | Jump to horizontal end |
| `g`/`G` | Jump to top/bottom of focused panel |
| `Enter` | Send selected request |
| `R` | Reload file from disk |
| `Tab` | Switch focused panel |
| `f` | Toggle panel maximize (fullscreen) |
| `v` | Toggle verbose response (show headers) |
| `/` | Filter request list |
| `Esc` | Close overlay / exit maximize |
| `?` | Toggle help overlay |
| `q` | Quit |
| `Ctrl+C` | Force quit |
## .http File Format
```http
@host = https://api.example.com
@token = my-api-token
### Get all users
GET {{host}}/users
Authorization: Bearer {{token}}
### Create user
POST {{host}}/users
Content-Type: application/json
{
"name": "John",
"email": "john@example.com"
}
```