# pardnchiu/go-rest-client

> Terminal REST client in Go by Pardn Chiu (邱敬幃): run VSCode REST Client .http files in a TUI with hot reload and live SSE streaming.

Maintained by 邱敬幃 Pardn Chiu (pardnchiu), Pardn Co., Ltd, Taiwan · Infrastructure Engineering. Source: https://github.com/pardnchiu/go-rest-client

Full text in one file: [English](https://go-rest-client.pardn.io/llms-full.txt) · [中文](https://go-rest-client.pardn.io/zh/llms-full.txt)

## Overview

- [Home](https://go-rest-client.pardn.io/index.md): Terminal REST client in Go by Pardn Chiu (邱敬幃): run VSCode REST Client .http files in a TUI with hot reload and live SSE streaming.
- [Getting Started](https://go-rest-client.pardn.io/getting-started.md): Install go-rest-client with go build or go install, create your first .http file, and send a request from the terminal.

## Writing Requests

- [.http File Format](https://go-rest-client.pardn.io/http-file-format.md): How go-rest-client splits .http files into requests: ### separators, ### Name labels, request line regex, and comments.
- [Headers and Body](https://go-rest-client.pardn.io/http-file-format-headers-body.md): Rules that classify lines after the request line as headers or body: header name validation, blank line, { and [ triggers.

## Using the TUI

- [Keyboard Controls](https://go-rest-client.pardn.io/keyboard-controls.md): Every key in the go-rest-client TUI: arrow navigation, Enter to send, Tab focus switching, Esc and Ctrl+C to quit.
- [Response Display](https://go-rest-client.pardn.io/response-display.md): How responses render in the info pane: status colors, headers, request duration, JSON pretty-printing, and the hint bar.
- [Request Errors](https://go-rest-client.pardn.io/response-errors.md): What go-rest-client shows when a request cannot be built, fails to connect, times out, or fails while reading the body.
- [SSE Streaming](https://go-rest-client.pardn.io/sse-streaming.md): Live Server-Sent Events display: text/event-stream detection, line-by-line rendering, 100-line cap, event count, 120s limit.
- [Hot Reload](https://go-rest-client.pardn.io/hot-reload.md): How go-rest-client watches the .http file with fsnotify, debounces saves by 200ms, reloads requests, and keeps the cursor.

## Concepts

- [Architecture](https://go-rest-client.pardn.io/architecture.md): One-diagram overview of go-rest-client: cmd/tui entry, internal/parser, internal/ui, fsnotify watcher, and net/http client.

## Reference

- [CLI Reference](https://go-rest-client.pardn.io/cli-reference.md): gorc command syntax, the seven startup checks with their stderr messages, exit codes, and binary names per install method.
- [Internal Packages](https://go-rest-client.pardn.io/internal-packages.md): Exported types and functions of internal/ui and internal/parser: TUI, Request, NewTUI, UpdateLeftView, ReadFile, WatchFile.
- [Known Limitations](https://go-rest-client.pardn.io/known-limitations.md): Confirmed limits in go-rest-client v0.1.2: dropped requests, no variables, fixed 120s timeout, and rename-based saves.

## 中文文件

- [首頁](https://go-rest-client.pardn.io/zh/index.md): 邱敬幃（Pardn Chiu）開發的 Go 終端機 REST API 測試工具：執行 .http 檔、存檔重載、SSE 串流。
- [快速開始](https://go-rest-client.pardn.io/zh/getting-started.md): 以 go build 或 go install 安裝 go-rest-client，建立第一個 .http 檔並在終端機送出請求。
- [.http 檔案格式](https://go-rest-client.pardn.io/zh/http-file-format.md): go-rest-client 如何切分 .http 檔：### 分隔線、### 名稱、請求行正規式與註解規則。
- [Header 與 Body](https://go-rest-client.pardn.io/zh/http-file-format-headers-body.md): 請求行之後的每一行如何判定為 Header 或 Body：Header 名稱驗證、空行與 { [ 觸發規則。
- [鍵盤操作](https://go-rest-client.pardn.io/zh/keyboard-controls.md): go-rest-client TUI 的所有按鍵：方向鍵瀏覽、Enter 送出、Tab 切換焦點、Esc 與 Ctrl+C 離開。
- [回應顯示](https://go-rest-client.pardn.io/zh/response-display.md): 回應在資訊面板的呈現：狀態碼顏色、Header、請求耗時、JSON 自動縮排與提示列格式。
- [請求錯誤](https://go-rest-client.pardn.io/zh/response-errors.md): 請求無法建立、連線失敗、逾時或讀取 Body 失敗時，go-rest-client 顯示的內容。
- [SSE 串流](https://go-rest-client.pardn.io/zh/sse-streaming.md): SSE 即時顯示：text/event-stream 偵測、逐行渲染、100 行上限、事件數與 120 秒逾時。
- [存檔即時重載](https://go-rest-client.pardn.io/zh/hot-reload.md): go-rest-client 以 fsnotify 監控 .http 檔、200ms 防抖重新載入請求並保留游標位置的方式。
- [架構](https://go-rest-client.pardn.io/zh/architecture.md): go-rest-client 架構概覽：cmd/tui、internal/parser、internal/ui、fsnotify 與 net/http。
- [命令列參考](https://go-rest-client.pardn.io/zh/cli-reference.md): gorc 命令語法、七項啟動檢查與對應 stderr 訊息、結束碼，以及各安裝方式的執行檔名稱。
- [內部套件](https://go-rest-client.pardn.io/zh/internal-packages.md): internal/ui 與 internal/parser 的匯出型別與函式：TUI、Request、NewTUI、ReadFile、WatchFile 等。
- [已知限制](https://go-rest-client.pardn.io/zh/known-limitations.md): go-rest-client v0.1.2 已確認的限制：請求遺失、不支援變數、固定 120 秒逾時與改名式存檔。

## Optional

- [Release Notes](https://go-rest-client.pardn.io/released/index.md): pardnchiu/go-rest-client changelog by version