Curly - Interactive cURL Helper

Curly is an open source interactive command-line tool that simplifies the process of constructing cURL requests by guiding users through request building.

Features

• Interactive request building for HTTP methods (GET, POST, PUT, PATCH, DELETE)
• Stores request history and allows recalling previous requests
• Selects and executes past requests using a fuzzy finder
• Easily cleans request history

Installation

Ubuntu (via Launchpad PPA)

1. Add the PPA repository:

   sudo add-apt-repository ppa:curly-tool/curly
   sudo apt update

2. Install Curly:

   sudo apt install curly

3. Verify the installation:

   curly --version

Manual Installation

1. Clone the repository:

   git clone https://github.com/curly-tool/curly.git

2. Make the script executable and move it to your /bin:

   chmod +x curly/curly
   sudo mv curly/curly /usr/local/bin/

3. Verify the installation:

   curly --version

---

Usage

Building a New Request

To start an interactive session to build a cURL request:

curly --http

Contribution

We welcome contributions to Curly! Whether you're reporting a bug, suggesting an improvement, or adding new features, your help is appreciated.

How to Contribute (local build)

1. Fork the Repository:

   • Go to the Curly GitHub repository and click the "Fork" button to create your own copy.

2. Clone Your Fork:

   • Clone the repository to your local machine using:

     git clone https://github.com/curly-tool/curly.git
     cd curly

3. Create a Feature Branch:

   • git checkout -b feature/your-feature-name

4. Make Your Changes:

   • Implement your feature, bug fix, or documentation update.

5. Code Style Guidelines

   • To ensure consistency:

   • Follow ShellCheck guidelines for shell scripting. Use shellcheck to lint your code before submitting:

   • Install shellcheck: sudo apt install shellcheck

   • Then Run: shellcheck curly

6. Run bats unit tests

   • Run tests to verify everything's functional: sudo apt install bats

   • Run: bats tests/

   • (Optional) Add tests for your changes.

7. Commit Changes:

   • Follow conventional commit messages (e.g., feat:, fix:, docs:):

     git add .
     git commit -m "feat: add support for PATCH method"

8. Push to Your Fork:

   • Push your changes to your GitHub fork:

     git push origin feature/your-feature-name

9. Create a Pull Request:

   • Go to the original repository and click the "New Pull Request" button.
   • Provide a detailed description of your changes.

---

How to Contribute (dockerized build)

1. Fork the Repository:

   • Go to the Curly GitHub repository and click the "Fork" button to create your own copy.

2. Clone Your Fork:

   • Clone the repository to your local machine using:

     git clone https://github.com/curly-tool/curly.git
     cd curly

3. Create a Feature Branch:

   • git checkout -b feature/your-feature-name

4. Make Your Changes:

   • Implement your feature, bug fix, or documentation update.

5. Test out changes in the 'curly-local-run' container

   • Navigate to: ./docker
   • Run: docker compose -f docker-compose.yml build
   • Then Run: docker compose -f docker-compose.yml up -d
   • Enter the container with: docker exec -it curly-local-run bash
   • Unit Testing: unit testing is run on container start-up, inspect with: docker logs -f curly-local-run

6. Code Style Check: Within the container

   • To ensure consistency:

   • Follow ShellCheck guidelines for shell scripting. Use shellcheck to lint your code before submitting:

   • Run: shellcheck usr/local/bin/curly

7. Commit Changes:

   • Follow conventional commit messages (e.g., feat:, fix:, docs:):

     git add .
     git commit -m "feat: add support for PATCH method"

8. Push to Your Fork:

   • Push your changes to your GitHub fork:

     git push origin feature/your-feature-name

9. Create a Pull Request:

   • Go to the original repository and click the "New Pull Request" button.
   • Provide a detailed description of your changes.

---

Reporting Issues

If you encounter any bugs or have feature requests:

1. Check for Existing Issues:

   • Before submitting, browse the issue tracker to see if your issue has already been reported.

2. Open a New Issue:

   • Click "New Issue" and provide a clear title and description.
   • Include:
     • Steps to reproduce the issue.
     • Expected vs. actual behavior.
     • Your environment details (OS, version, etc.).

Example issue format:

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Include steps to reproduce the behavior.

**Expected behavior**
Describe what you expected to happen.

**System Information:**
Include OS information

Acknowledgments

This project utilizes httpbin for testing HTTP requests. httpbin is licensed under the ISC License.