Skip to content

Gabriel-Spinola/PokeGelo-CLI

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

53 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PokeGelo-CLI

OIG_1

PokeGelo-CLI is a command-line interface (CLI) tool designed to simplify sending HTTP requests, making it easier and more intuitive compared to using curl. With PokeGelo-CLI, you can send HTTP requests by providing a JSON file containing the request and its body. This tool is especially useful for testing APIs, debugging, and automating HTTP requests. Inspired by Quaezo

Features

  • Send HTTP requests using a JSON file.
  • Simplified syntax compared to curl.
  • Supports various HTTP methods: GET, POST, PUT, PATCH, DELETE, etc.
  • Unit testing implementation ensures the reliability of the tool.
  • Concurrent Processing: Couroutines for faster processing of multiple files concurrently.
  • Dynamic Request Body Building: Build HTTP request bodies dynamically by reading any JSON file.

Installation

To install PokeGelo-CLI, follow these steps:

Clone the Repository:

git clone https://github.com/Gabriel-Spinola/PokeGelo-CLI.git
cd PokeGelo-CLI

Build the Executable:

go build -o poke

Move the Executable to a Directory in Your $PATH:

sudo mv poke /usr/local/bin

Now, you can use poke from the command line.

Usage

To send an HTTP request, create a JSON file specifying the request method, URL, headers, and body. For example:

{
  "method": "POST",
  "url": "https://api.example.com/resource",
  "headers": {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN"
  },
  "body": {
    "key": "value"
  }
}

Then, use the following command to send the request:

poke net send -f /path/to/your/request.json

This will send the specified HTTP request using the information provided in the JSON file.

poke net send -w -f /path/to/your/request.json

This will send the specified HTTP request using the information provided in the JSON file and write the response to the output folder.

Building Multiple Requests

To build multiple requests, use the following command:

poke net build -f /path/to/file1.json,/path/to/file2.json

This will build multiple requests concurrently.

Unit Testing

PokeGelo-CLI includes comprehensive unit tests to ensure its functionality and reliability. You can run the tests using the following command:

cd poke/tests
go test

Future Plans

  • Docker Support: Dockerize PokeGelo-CLI for easy deployment and management.
  • Interactive Mode: Implement an interactive mode for building requests directly from the command line.
  • Better request bulding and other utilities.

Contribution Guidelines

Contributions to PokeGelo-CLI are welcome! If you have any ideas for improvements, bug fixes, or new features, feel free to open an issue or submit a pull request.

License

PokeGelo-CLI is licensed under the GPL 3.0 License. Feel free to use, modify, and distribute this tool as needed.

Thank you for using PokeGelo-CLI! If you have any questions or feedback, please don't hesitate to reach out. Happy coding!

TODO:

  • Build project
  • API requests like postman
  • Write first test
  • Request builder
  • Documentation
  • Configurations
  • Tests
  • Dockerize