https://github.com/derekkraan/curl_req
req to curl and back
https://github.com/derekkraan/curl_req
Last synced: 6 months ago
JSON representation
req to curl and back
- Host: GitHub
- URL: https://github.com/derekkraan/curl_req
- Owner: derekkraan
- License: mit
- Created: 2024-05-28T13:10:35.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-09T13:21:59.000Z (7 months ago)
- Last Synced: 2025-03-29T01:03:52.503Z (7 months ago)
- Language: Elixir
- Homepage: https://hex.pm/packages/curl_req
- Size: 201 KB
- Stars: 66
- Watchers: 2
- Forks: 6
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# 🥌 CurlReq
🥌 🥌 🥌 🥌 🥌 🥌
Req is awesome, but the world speaks curl.
Next time you're debugging a 3rd party API and need to ask for support, you can just toss in this line:
```elixir
|> CurlReq.inspect()
```
And you'll have the full curl command.
[Read the announcement here](https://codecodeship.com/blog/2024-06-03-curl_req).
## Usage
### Req to Curl
```elixir
# Turn a Req request into a `curl` command.
iex> Req.new(url: "/fact", base_url: "https://example.com/")
...> |> CurlReq.to_curl()
"curl --compressed -X GET https://example.com/fact"
# Or use `CurlReq.inspect/2` to inspect inline.
Req.new(url: "https://example.com")
|> CurlReq.inspect()
|> Req.request!()
#=> curl --compressed -X GET https://example.com
```
### Curl to Req
`CurlReq` also implements the `~CURL` sigil, which converts a curl command to its corresponding Req request.
```elixir
iex> import CurlReq
...> ~CURL(curl https://www.example.com)
...> # |> Req.request!()
```
or use `CurlReq.from_curl/1`:
```elixir
iex> CurlReq.from_curl("curl https://example.com")
...> # |> Req.request!()
```
### Req Plugin
One final feature to note the Req plugin, `CurlReq.Plugin`. Use `CurlReq.Plugin.attach/2` to set up curl logging (inspired by `TeslaCurl`).
```elixir
iex> Req.new(url: "/fact", base_url: "https://example.com/")
...> |> CurlReq.Plugin.attach()
...> # |> Req.request!()
```
## Supported Features
CurlReq parses a bunch of cURL flags and translates them to Req.Request structs and vice versa. To get an up to date list you can call `CurlReq.Curl.flags/0`
### Supported Flags
The following flags are supported in all directions (from Req, from cURL, to Req, to cURL)
| Long | Short | Limitation |
| -------------- | ----- | ------------------------------ |
| `--header` | `-H` | |
| `--request` | `-X` | |
| `--data` | `-d` | No file interpolation with `@` |
| `--data_raw` | | No file interpolation with `@` |
| `--data_ascii` | | No file interpolation with `@` |
| `--cookie` | `-b` | |
| `--head` | `-I` | |
| `--form` | `-F` | |
| `--location` | `-L` | |
| `--user` | `-u` | Only as basic auth |
| `--compressed` | | |
| `--proxy` | `-x` | |
| `--proxy_user` | `-U` | Only as basic auth |
| `--netrc` | `-n` | |
| `--netrc_file` | | |
| `--insecure` | `-k` | |
| `--user_agent` | `-A` | |
### Ignored flags
The following flags are currently ignored because they mostly describe the runtime behaviour and not the request itself.
| Long | Short |
| --------------- | ----- |
| `--verbose` | `-v` |
| `--output` | `-o` |
| `--remote_name` | `-O` |
| `--show-error` | `-S` |
| `--silent` | `-s` |
| `--fail` | `-f` |
## Installation
The package can be installed
by adding `curl_req` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:curl_req, "~> 0.100.0"}
]
end
```
The docs can be found at .
## Contributions
Contributions are welcome! There are gaps in the library, and this is open source, so let's work together to fill them!
## How to contribute
- Clone the repository to your computer.
- Add to your mix.exs file in your project: `{:curl_req, path: "~/path/to/curl_req"}`.
- Tinker until it does what you want.
- Add a test covering your case.
- Add a changelog entry if applicable.
- Submit a PR!