Skip to content

Commit

Permalink
Add quick start guide
Browse files Browse the repository at this point in the history
  • Loading branch information
nakabonne committed Sep 16, 2020
1 parent d260704 commit b30eed6
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 6 deletions.
29 changes: 25 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,32 +8,53 @@ Another load testing tool, inspired by [vegeta](https://github.com/tsenart/veget

</div>

`ali` comes with a simple terminal based UI, lets you generate HTTP requests and plot the results in real-time. With the help of [vegeta](https://github.com/tsenart/vegeta), it's available as a versatile load testing tool.
`ali` comes with a simple terminal based UI, lets you generate HTTP requests and plot the results in real-time.
With it, real-time analysis can be performed on the terminal.

## Installation

Executables are available through the [releases page](https://github.com/nakabonne/ali/releases).

## Usage
### Quickstart
Give the target URL and press Enter, then the attack will be launched with default options.

### Options

**Rate Limit**

**Duration**

**Timeout**

**Method**

**Header**

**Body**

## Features

#### Plot in real-time
Currently it only plots Latencies, but in the near future more metrics will be drawn do A as well.
Currently it only plots latencies, but in the near future more metrics will be drawn as well.

![Screenshot](images/real-time.gif)

#### Visualize the attack progress
This will help you during long tests.

![Screenshot](images/progress.gif)

#### Mouse support
With the help of [mum4k/termdash](https://github.com/mum4k/termdash), intuitive operation is supported.

![Screenshot](images/mouse-support.gif)


## Built with
- [mum4k/termdash](https://github.com/mum4k/termdash/wiki/Termbox-API)
- [mum4k/termdash](https://github.com/mum4k/termdash)
- [nsf/termbox-go](https://github.com/nsf/termbox-go)
- [vegeta](https://github.com/tsenart/vegeta)
- [tsenart/vegeta](https://github.com/tsenart/vegeta)


## LoadMap
Expand Down
4 changes: 2 additions & 2 deletions gui/widgets.go
Original file line number Diff line number Diff line change
Expand Up @@ -66,11 +66,11 @@ func newWidgets() (*widgets, error) {
if err != nil {
return nil, err
}
headerInput, err := newTextInput("Header: ", "", 30)
headerInput, err := newTextInput("Header: ", "", 50)
if err != nil {
return nil, err
}
timeoutInput, err := newTextInput("Timeout: ", attacker.DefaultTimeout.String(), 30)
timeoutInput, err := newTextInput("Timeout: ", attacker.DefaultTimeout.String(), 50)
if err != nil {
return nil, err
}
Expand Down

0 comments on commit b30eed6

Please sign in to comment.