Seich
/
Beau
mirror of https://github.com/Seich/Beau.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated ReadMe

This commit is contained in:
David Diaz 2017-12-23 00:46:23 -06:00
parent 930a957bf3
commit 458f0f65ce
2 changed files with 16 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@ -1 +1,2 @@
node_modules/ node_modules/
coverage/

22
README.md
View File

@ -8,23 +8,27 @@
## What is Beau? ## What is Beau?
Beau, is a CLI that executes HTTP requests based on a YAML configuration file. This makes testing easy, it allows you to share test requests with others as part of your repo. Beau, is a CLI that executes HTTP requests based on a YAML configuration file. This makes testing easy, it allows you to share test requests with others as part of your repo.
![A Gif showing how beau works](http://files.martianwabbit.com/beau.gif) ![A Gif showing how beau works](http://files.martianwabbit.com/beau2.gif)
## Installation ## Installation
npm install -g beau npm install -g beau
## Usage ## Usage
beau [options] -r <Request Alias> ⚡ beau --help
Usage: beau [options] [command]
Options: Options:
-h, --help output usage information
-V, --version output the version number -V, --version output the version number
-r, --request [request] The alias for the request you'd like to trigger. -h, --help output usage information
-v, --verbose Show all the information related to the current request and it's response.
-c, --config [file] Specify your request config file. Defaults to beau.yml in the current directory.
-l, --list List all requests in the config file. Commands:
-t, --truncate [length] Truncate the content to the given length
request [options] <alias>
list [options]
## Example Configuration File ## Example Configuration File
@ -50,7 +54,7 @@ Beau, is a CLI that executes HTTP requests based on a YAML configuration file. T
archived: true archived: true
## Example Usage ## Example Usage
beau -r profile beau request profile
That would execute the profile request along with it´s dependencies. In this case, the session request would be made as well since we are using it´s response value as part of our current request. That would execute the profile request along with it´s dependencies. In this case, the session request would be made as well since we are using it´s response value as part of our current request.