Documentation
Getting start

Getting Started with httui

Welcome to httui, your terminal-based TUI application for managing HTTP requests efficiently. This guide will help you familiarize yourself with the basic operations and navigation within httui.

Prerequisite Check

Before you begin, make sure that httui is properly installed on your machine. You can start httui by entering:

httui

In your terminal. If httui starts up, you're ready to proceed. If not, please refer back to the Installation Guide.

Launching httui

Simply type httui in your terminal and press Enter. This command will launch the TUI, where all interactions are done through the keyboard.

Basic Navigation

httui uses Vim-like keybindings for navigation, making it familiar to users comfortable with Vim or other modal text editors.

  • Navigate between requests or groups: Use j and k to move up and down through your list of requests or groups.
  • Switch between different views or panels: Use h and l to move left and right between panels, such as different environments or request details.

Working with Workspaces

Creating and Managing Workspaces

  • Create a new workspace: Navigate to the workspace management area and press shift + s to open the dialog for creating a new workspace.
  • Switch between workspaces: Use ctrl + s to cycle through existing workspaces.

Managing Requests and Groups

Creating Requests or Request Groups

  • Add a new request or group: Press a or c when in the request view to start the process of adding a new request or a group of requests.
  • Edit a request or group: Press shift + r to modify the selected request or group details.
  • Execute a selected request: Navigate to the request you want to execute and press e to send the request and view the response in the output panel.

Advanced Features

Using Variables

  • Open variable editor: Press ctrl + e to open the variable editor where you can define and modify variables specific to the current workspace.

Using Output from One Request in Another

  • Chain requests: Utilize the output of one request as input for another by setting up dependencies in the request configuration or using shared variables.

This guide provides you with the basics to start managing your HTTP requests with httui. Dive into the capabilities of this powerful TUI application and streamline your HTTP testing and development directly from your terminal.