# hitt [![](https://img.shields.io/crates/v/hitt.svg)](https://crates.io/crates/hitt) [![](https://github.com/hougesen/hitt/actions/workflows/validate.yml/badge.svg)](https://github.com/hougesen/hitt/actions/workflows/validate.yml) [![](https://codecov.io/gh/hougesen/hitt/branch/main/graph/badge.svg)](https://codecov.io/gh/hougesen/hitt) hitt is a command line HTTP testing tool focused on speed and simplicity. ![hitt example](https://2461249990-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGvgZwB5br142O10EMxCU%2Fuploads%2Fgit-blob-fe71cc431d1fe475e91c83fdd867793f997d112a%2Fhitt-cli-example.png?alt=media) ``` hitt 0.0.21 Command line HTTP testing tool focused on speed and simplicity Mads Hougesen Usage: hitt Commands: run Send http requests sse Listen to sse events completions Generate shell completions help Print this message or the help of the given subcommand(s) Options: -h, --help Print help -V, --version Print version ``` ## Install ### Linux & MacOS ```shell curl --proto '=https' --tlsv1.2 -LsSf https://github.com/hougesen/hitt/releases/latest/download/hitt-installer.sh | sh ``` ### Windows ```powershell powershell -ExecutionPolicy ByPass -c "irm https://github.com/hougesen/hitt/releases/latest/download/hitt-installer.ps1 | iex" ``` ### Cargo hitt can be installed using Cargo. ```shell cargo install hitt --locked ``` If you do not have Cargo installed, you need to [install it first](https://www.rust-lang.org/learn/get-started). ### npm/npx You can install hitt using [npm](https://www.npmjs.com/package/hitt-cli): ```shell npm install -g hitt-cli hitt run hello-world.http ``` or run it directly using npx: ```shell npx hitt-cli run hello-world.http ``` ### Homebrew ```shell brew install hougesen/tap/hitt ``` ## Usage To send a request create a file ending in `.http`. The syntax of `.http` files is pretty straightforward: ```http GET https://mhouge.dk/ ``` The file can then be run using the following command: ```shell hitt run PATH_TO_FILE ``` That is all that is need to send a request. ``` Send http requests Usage: hitt run [OPTIONS] [PATHS]... Arguments: [PATHS]... Path to .http files, or directories if supplied with the `--recursive` argument Options: --timeout Request timeout in milliseconds --var = Variables to pass to request -r, --recursive Enable to run directory recursively --fail-fast Exit on error response status code --hide-body Whether or not to show response body --hide-headers Whether or not to show response headers --disable-formatting Disable pretty printing of response body -h, --help Print help -V, --version Print version ``` ### Arguments | Argument | Description | | ------------------------ | ------------------------------ | | `--var =` | Variables to pass to request | | `--recursive` | Run all files in directory | | `--fail-fast` | Exit on status code 4XX or 5xx | | `--hide-headers` | Hide response headers | | `--hide-body` | Hide response body | | `--timeout ` | Request timeout in ms | ### Request headers Request headers can be added by writing key value pairs (`KEY:VALUE`) on a new line after the method and URL: ```http GET https://mhouge.dk/ key:value ``` Leading spaces in the header value is ignored, so `KEY: VALUE` and `KEY:VALUE` will both have the value `VALUE`. ### Request body A body can be sent with the request by creating a blank line, followed by the desired body input. Please note, hitt **does not** infer content type. That has to be written as a header. ```http POST https://mhouge.dk/ content-type:application/json { "key": "value" } ``` ### Multiple request in single file Multiple requests can be written in a single file by adding a line with `###` as a separator: ```http GET https://mhouge.dk/ ### GET https://mhouge.dk/ ``` ### Variables hitt has support for request variables. A variable can be set in a file using the following syntax `@name = VALUE`. Whitespace is ignored. Variables are used by wrapping the name in curly brackets (`{{ name }}`). ```http @variable_name = localhost GET {{ variable_name }}/api ``` In-file variables are not shared between other files. #### Variable arguments Variables can be passed to all requests using the `--var =` argument: ```http # file.http GET {{ host }}/api ``` The file can the be run: ```shell hitt run --var host=localhost:5000 file.http ``` ### Server sent events (SSE) A SSE listener can be started using the `hitt sse` command. ```shell hitt sse https://sse.dev/test ``` ``` Listen to sse events Usage: hitt sse Arguments: Options: -h, --help Print help -V, --version Print version ``` ### Shell completions Shell completions can be generated using `hitt completions `. ``` Generate shell completions Usage: hitt completions Arguments: [possible values: bash, elvish, fish, nushell, powershell, zsh] Options: -h, --help Print help -V, --version Print version ``` #### Bash Add the following to your `.bashrc`. ```bash eval "$(hitt completions bash)" ``` #### Zsh Add the following to your `.zshrc`. ```zsh eval "$(hitt completions zsh)" ``` #### Fish Add the following to `~/.config/fish/config.fish`. ```fish hitt completions fish | source ``` #### PowerShell Add the following to your PowerShell configuration (Can be found by running `$PROFILE`). ```powershell Invoke-Expression (&hitt completions powershell) ``` #### Elvish Add the following to `~/.elvish/rc.elv`. ```elvish eval (hitt completions elvish) ``` ## Neovim hitt can be run directly from Neovim. > \[!NOTE] The `hitt` executable must be available in your path for the plugin to work. ### Install #### Lazy ```lua local hitt_plugin = { "hougesen/hitt", opts = {}, } ``` ### Usage The plugin exposes a single command `:HittSendRequest`, which can be bound to a keymap like this: ```lua -- ~/.config/nvim/after/plugin/hitt.lua local hitt = require("hitt") vim.keymap.set("n", "rr", hitt.HittSendRequest, {}) ``` ![hitt neovim window](https://2461249990-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGvgZwB5br142O10EMxCU%2Fuploads%2Fgit-blob-a46ab54765199760973feb33d786fc55cf25e45b%2Fhitt-neovim-example.png?alt=media) ### Configuration | Name | Default | Description | | -------------- | ------- | --------------------------------- | | window\_width | 80 | Window width in percentage | | window\_height | 80 | Window height in percentage | | fail\_fast | false | Enables the `--fail-fast` options | #### HTTP syntax highlighting Syntax highlighting can be enabled by installing the `http` treesitter parser (`:TSInstall http`) and adding a file association for `.http` files. ```lua vim.filetype.add({ extension = { http = "http", }, }) ``` ## Disclaimer hitt is most likely not ready for main stream usage. I ([Mads Hougesen](https://mhouge.dk)) am primarily developing it based on features I believe to be useful, or fun to develop.