This repository has been archived by the owner on Jul 14, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
62 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
# PostWoman CLI | ||
Use Postwoman's CLI direct from your terminal. | ||
|
||
# Usages | ||
``` | ||
NAME: | ||
Postwoman CLI - Test API endpoints without the hassle | ||
USAGE: | ||
cli [global options] command [command options] [arguments...] | ||
VERSION: | ||
0.0.1 | ||
DESCRIPTION: | ||
Made with <3 by Postwoman Team | ||
COMMANDS: | ||
get Send a GET request | ||
post Send a POST Request | ||
put Send a PUT Request | ||
patch Send a PATCH Request | ||
delete Send a DELETE Request | ||
help, h Shows a list of commands or help for one command | ||
GLOBAL OPTIONS: | ||
--help, -h show help | ||
--version, -v print the version | ||
``` | ||
---- | ||
## GET | ||
**Usage** | ||
``` | ||
NAME: | ||
cli get - Send a GET request | ||
USAGE: | ||
cli get [command options] [arguments...] | ||
OPTIONS: | ||
--url value The URL/Endpoint you want to check (default: "https://reqres.in/api/users") | ||
--token value Send the Request with Bearer Token | ||
-u value Add the Username | ||
-p value Add the Password | ||
``` | ||
## POST | ||
**Usage** | ||
``` | ||
NAME: | ||
cli post - Send a POST Request | ||
USAGE: | ||
cli post [command options] [arguments...] | ||
OPTIONS: | ||
--url value The URL/Endpoint you want to check (default: "https://reqres.in/api/users") | ||
--token value Send the Request with Bearer Token | ||
-u value Add the Username | ||
-p value Add the Password | ||
--ctype value Change the Content Type (default: "application/json") | ||
--body value Body of the Post Request | ||
``` |