Skip to content

Latest commit

 

History

History
80 lines (53 loc) · 1.63 KB

README.md

File metadata and controls

80 lines (53 loc) · 1.63 KB
Raw

@techthos/web-performer

Web-Performer Banner

@techthos/web-performer is a robust tool designed to perform HTTP actions based on YML definitions. Streamline your web requests and automate your workflows with ease using our intuitive YML configuration.

Features

  • Perform complex HTTP and GraphQL requests with simple YML configurations.
  • Customizable and user-friendly CLI interface.
  • Efficient and streamlined for administrative and development use.

Installation

Install @techthos/web-performer via npm

npm install @techthos/web-performer

Usage

After installation, you can use the performer command to execute your HTTP actions. Here's a basic example:

performer run -f <path-to-your-yml-file>

Refer to the YML configuration guide for detailed usage.

Configuration

Define your HTTP requests and GraphQL queries in a YML file. Here's a structure example:

version: "1"
type: graphql
endpoint: <your-endpoint>
headers:
  - name: <header-name>
    value: <header-value>
...

For more see:

Building

To build the project, run:

npm run build

Contributing

We welcome contributions! Please submit pull requests for any enhancements, bug fixes, or features.

Author

Techthos L.P. Email: [email protected]

License

This project is licensed under the MIT License.

You can customize this README.md to better fit your project's specific needs and add additional sections as required.