Treki CLI

A CLI tool for API testing locally or syncing with your Treki account for advanced testing.

Features

• Send GET | POST | PUT | PATCH | DELETE requests directly from your terminal.
• View additional information like status code and headers by using verbose mode.
• Send custom body and headers when sending requests.

Installation

Linux

Run this command on your terminal, and it will automatically run the installation script and install treki-cli on your system.

curl -sSL https://raw.githubusercontent.com/aether-flux/treki-cli/main/scripts/linux/install.sh | bash

Windows

For Windows users, open PowerShell (preferably in Administrator Mode) and run the following command : (For PowerShell)

iwr -useb https://raw.githubusercontent.com/aether-flux/treki-cli/main/scripts/windows/install.bat | iex

(For CMD)

powershell -Command "iwr -useb https://raw.githubusercontent.com/aether-flux/treki-cli/main/scripts/windows/install.bat | iex"

Usage

Commands

Sending requests

• 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.
• run : Run a saved request from the database by its ID.

Authentication

• login: Login to an account using email and password.
• whoami: View details of logged in account, if logged in. Displays username and email.

Options/Flags

• help or -h or --help : Display help information about the CLI.
• -v or --verbose : Display additional information like status code and headers.
• -b or --body : Send a body to the request as a JSON string.
• -H or --headers : Send headers to the request like 'key1:val1, key2:val2, ...'.

Example Usage

treki post https://jsonplaceholder.typicode.com/posts -b '{"title": "New Post", "body": "Lorem ipsum dolor et smth smth.", "userId": 1}'