Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/abdfnx/resto
🔗 Send pretty HTTP & API requests with TUI.
https://github.com/abdfnx/resto
api cli golang http http-client requests rest rest-api resto terminal-based tui user-interface
Last synced: about 4 hours ago
JSON representation
🔗 Send pretty HTTP & API requests with TUI.
- Host: GitHub
- URL: https://github.com/abdfnx/resto
- Owner: abdfnx
- License: mit
- Created: 2021-11-29T18:23:23.000Z (about 3 years ago)
- Default Branch: dev
- Last Pushed: 2024-07-19T06:20:07.000Z (6 months ago)
- Last Synced: 2024-10-12T02:33:00.396Z (3 months ago)
- Topics: api, cli, golang, http, http-client, requests, rest, rest-api, resto, terminal-based, tui, user-interface
- Language: Go
- Homepage:
- Size: 747 KB
- Stars: 234
- Watchers: 3
- Forks: 14
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: .github/SECURITY.md
Awesome Lists containing this project
- jimsghstars - abdfnx/resto - 🔗 Send pretty HTTP & API requests with TUI. (Go)
README
> a CLI app can send pretty HTTP & API requests with TUI.
## Installation
### Using script
* Shell
```
curl -fsSL https://git.io/resto | bash
```
* PowerShell
```
iwr -useb https://git.io/resto-win | iex
```
**then restart your powershell**
### Go package manager
```bash
go install github.com/abdfnx/resto@latest
```
### GitHub CLI
```bash
gh extension install abdfnx/gh-resto
```
### Via Docker
```bash
docker run -it restohq/resto
```
> full container:
```bash
docker run -it restohq/resto-full
```
## Usage
* Open Resto UI
```bash
resto
```
* Send a request to a URL
```bash
resto get https://api.github.com
```
* Send a request to a URL and use resto editor
```bash
resto post https://localhost:3000/v1/login --content-type json --editor
```
* Read Body from stdin
```bash
cat schema.graphql | resto post https://api.spacex.land/graphql --content-type graphql --body-stdin
```
* Use Authentecation with Basic Auth or Bearer Token
```bash
# Bearer Token
resto delete https://api.secman.dev/api/logins/13 --content-type json --token TOKEN
# Basic Auth
resto delete https://api.secman.dev/api/logins/13 --content-type json --username USERNAME --password PASSWORD
```
* Save response to a file
```bash
resto get http://localhost:3333/api/v1/hello --save response.json
```
* Install binary app from script URL and run it.
```bash
resto install https://yarnpkg.com/install.sh
resto i https://get.docker.com
```
* Send a request from Restofile
```bash
resto run
# from path
resto run --file ./examples/restofile/basic_request/Restofile
```
* Get the latest release/tag from repository
```bash
resto get-latest abdfnx/resto
# use another registry
resto get-latest 23028539 --registry gitlab.com
# with access token
resto get-latest spittet/node-postgresql --registry bitbucket.org --token YOUR-ACCESS-TOKEN
```
### 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
```
2. `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
```
3. `install` command flags
```
-H, --hidden hide the output
-s, --shell string shell to use default: bash
```
4. `run` command flags
```
-a, --all Show all response headers & status
-f, --file string Path to Restofile (Default: PATH/Restofile)
```
5. `get-latest` command flags
```
-r, --registry string The registry to use
-t, --token string The access token to use it the registry requires authentication
```
### Shortcuts
- Ctrl+P: **Open Resto Panel**
- Ctrl+H: **Open Help Guide**
- Ctrl+E: **Open Settings**
- Ctrl+S: **Save Request Body**
- Ctrl+U: **Update Your Resto**
- Ctrl+Q: **Quit**
## Documentation
Refer to our [**Wiki**](https://github.com/abdfnx/resto/wiki) for the documentation.