https://github.com/stacksjs/httx
🤖 A modern command-line & library HTTP client, "for the API era." Like httpie, written in & for TypeScript.
https://github.com/stacksjs/httx
api-client cli httpie library typescript
Last synced: about 1 year ago
JSON representation
🤖 A modern command-line & library HTTP client, "for the API era." Like httpie, written in & for TypeScript.
- Host: GitHub
- URL: https://github.com/stacksjs/httx
- Owner: stacksjs
- License: mit
- Created: 2025-01-23T20:52:29.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-28T23:35:31.000Z (about 1 year ago)
- Last Synced: 2025-05-29T14:12:13.728Z (about 1 year ago)
- Topics: api-client, cli, httpie, library, typescript
- Language: TypeScript
- Homepage: https://httx.netflix.app
- Size: 1.9 MB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
[![npm version][npm-version-src]][npm-version-href]
[![GitHub Actions][github-actions-src]][github-actions-href]
[](http://commitizen.github.io/cz-cli/)
# httx
> httx is a simple, fast, lightweight and user-friendly API client. Whether you are working with a CLI, a library or a server, httx is a perfect choice for making HTTP requests.
## Features
- 🌐 **API Requests**: _easily make API requests in a familiar way_
- 🤖 **CLI**: _a cross-platform CLI_
- 📚 **Library**: _use httx as a library in your project_
- ⚡ **Performant**: _extremely fast and efficient_
- 🪶 **Lightweight**: _built on web standards, lightweight & without dependencies_
- 🐶 **User-Friendly**: _user-friendly, simple, powerful API_
- 💪🏽 **Type-Safe**: _strongly-typed, including type-safe errors_
## Install
```bash
bun install -d @stacksjs/httx
```
> [!NOTE]
> We are trying to release under the `httx` package name, which is currently abandoned. Please @npmjs, we would love to!🙏🏽
## Get Started
Making requests is simple. There are two ways of getting started: _as a library or as a CLI._
### Library
Given the npm package is installed:
```ts
import type { HttxConfig } from 'httx'
// import { ... } from 'httx'
// ...
```
In case you are trying to start multiple proxies, you may use this configuration:
### CLI
```bash
httx get api.example.com/users
httx post api.example.com/users name=john email=john@example.com -j
httx get api.example.com/files file@./data.txt -m
httx get api.example.com/secure -a username:password
httx --help
httx --version
```
## Configuration
The Reverse Proxy can be configured using a `httx.config.ts` _(or `httx.config.js`)_ file and it will be automatically loaded when running the `reverse-proxy` command.
```ts
// httx.config.{ts,js}
import type { HttxOptions } from '@stacksjs/httx'
import os from 'node:os'
import path from 'node:path'
const config: HttxOptions = {
verbose: false,
}
export default config
```
_Then run:_
```bash
./httx
```
To learn more, head over to the [documentation](https://httx.netlify.app/).
## Testing
```bash
bun test
```
## Changelog
Please see our [releases](https://github.com/stacksjs/stacks/releases) page for more information on what has changed recently.
## Contributing
Please review the [Contributing Guide](https://github.com/stacksjs/contributing) for details.
## Community
For help, discussion about best practices, or any other conversation that would benefit from being searchable:
[Discussions on GitHub](https://github.com/stacksjs/stacks/discussions)
For casual chit-chat with others using this package:
[Join the Stacks Discord Server](https://discord.gg/stacksjs)
## Postcardware
“Software that is free, but hopes for a postcard.” We love receiving postcards from around the world showing where `httx` is being used! We showcase them on our website too.
Our address: Stacks.js, 12665 Village Ln #2306, Playa Vista, CA 90094, United States 🌎
## Sponsors
We would like to extend our thanks to the following sponsors for funding Stacks development. If you are interested in becoming a sponsor, please reach out to us.
- [JetBrains](https://www.jetbrains.com/)
- [The Solana Foundation](https://solana.com/)
## Credits
- [httpie](https://httpie.io/)
- [Chris Breuer](https://github.com/chrisbbreuer)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [LICENSE](https://github.com/stacksjs/stacks/tree/main/LICENSE.md) for more information.
Made with 💙
[npm-version-src]: https://img.shields.io/npm/v/@stacksjs/httx?style=flat-square
[npm-version-href]: https://npmjs.com/package/@stacksjs/httx
[github-actions-src]: https://img.shields.io/github/actions/workflow/status/stacksjs/httx/ci.yml?style=flat-square&branch=main
[github-actions-href]: https://github.com/stacksjs/httx/actions?query=workflow%3Aci