Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Inquiry about Integrating Curlie Documentation into tldr #75

Open
miguelsmuller opened this issue Aug 23, 2023 · 2 comments
Open

Inquiry about Integrating Curlie Documentation into tldr #75

miguelsmuller opened this issue Aug 23, 2023 · 2 comments

Comments

@miguelsmuller
Copy link

Hello Curlie Team,

I've been a user and fan of Curlie for some time now, and I greatly appreciate the efforts your team has put into creating a user-friendly interface for working with cURL commands.

I recently came across the tldr project (tldr-pages), which offers simplified and practical help pages for various command-line tools. It occurred to me that Curlie's ease of use and feature-rich frontend for cURL could be a valuable addition to the tldr project. This could help introduce more users to Curlie and provide them with a straightforward way to learn and use its capabilities.

I'm curious if there are any plans or discussions within your team to integrate Curlie's documentation and examples into the tldr-pages collection. It seems like a great opportunity to enhance the visibility and adoption of Curlie, while also contributing to the tldr community.

Additionally, I'd like to express my willingness to contribute to this effort if the Curlie team is interested. Whether it's assisting with documentation, providing examples, or helping with any technical aspects, I'd be more than happy to contribute my time and skills.

Thank you for your hard work on Curlie, and I'm looking forward to hearing your thoughts on this potential collaboration.

@rs
Copy link
Owner

rs commented Aug 23, 2023

Sure, feel free to contribute to this project with curlie docs.

@miguelsmuller
Copy link
Author

Thank you for your response! I appreciate your willingness to accept contributions to the Curlie documentation. Before I start working on integrating Curlie into the tldr-pages project, I'd like to share the current output for the curl command in tldr for the native curl tool:

curl

Transfers data from or to a server.
Supports most protocols, including HTTP, FTP, and POP3.
More information: <https://curl.se/docs/manpage.html>.

- Download the contents of a URL to a file:
    curl http://example.com --output path/to/file

- Download a file, saving the output under the filename indicated by the URL:
    curl --remote-name http://example.com/filename

- Download a file, following location redirects, and automatically continuing (resuming) a previous file transfer and return an error on server error:
    curl --fail --remote-name --location --continue-at - http://example.com/filename

- Send form-encoded data (POST request of type `application/x-www-form-urlencoded`). Use `--data @file_name` or `--data @'-'` to read from STDIN:
    curl --data 'name=bob' http://example.com/form

- Send a request with an extra header, using a custom HTTP method:
    curl --header 'X-My-Header: 123' --request PUT http://example.com

- Send data in JSON format, specifying the appropriate content-type header:
    curl --data '{"name":"bob"}' --header 'Content-Type: application/json' http://example.com/users/1234

- Pass a username and password for server authentication:
    curl --user myusername:mypassword http://example.com

- Pass a client certificate and key for a resource, skipping certificate validation:
    curl --cert client.pem --key key.pem --insecure https://example.com

Is there anything specific you would like to add or modify in this documentation for Curlie, or do you have any additional requirements for its integration into the tldr-pages project? Your feedback will help ensure that the documentation is comprehensive and user-friendly for the tldr community.

Screenshot 2023-08-23 at 14 38 24

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants