https://github.com/dever-labs/postly
A cross-platform API client built for teams
https://github.com/dever-labs/postly
api-client backstage developer-tools electron
Last synced: about 1 month ago
JSON representation
A cross-platform API client built for teams
- Host: GitHub
- URL: https://github.com/dever-labs/postly
- Owner: dever-labs
- License: mit
- Created: 2026-03-28T20:42:25.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2026-04-03T01:17:47.000Z (3 months ago)
- Last Synced: 2026-04-03T06:24:03.384Z (3 months ago)
- Topics: api-client, backstage, developer-tools, electron
- Language: TypeScript
- Homepage:
- Size: 1.26 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Postly
> A cross-platform API client built for teams — with native Backstage, GitHub, and GitLab integration.



---
## What is Postly?
Postly is a desktop API client similar to Postman, built with Electron. It's designed for developers who work with APIs discovered through internal developer portals or source control — not just manually created collections.
**Key differentiator:** Connect Postly to your Backstage instance, GitHub, or GitLab repository, and your APIs automatically appear as collections alongside locally created ones. Everything lives in one place.
---
## Features
### API Collections
- Organise requests into **collections** and **groups**
- Full request editor: GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS
- URL parameters, headers, and body (JSON, form-data, URL-encoded, raw, binary, GraphQL)
- Per-request response viewer with syntax highlighting (pretty, raw, preview)
### Authentication — all levels
Configure auth once on a collection or group, and requests inherit it automatically.
| Type | Description |
|---|---|
| **Bearer Token** | Static bearer token |
| **Basic Auth** | Username + password |
| **JWT Bearer** | JWT token with configurable prefix |
| **OAuth 2.0** | Authorization Code (PKCE) or Client Credentials — token auto-cached and refreshed |
| **NTLM** | Windows authentication with domain/workstation |
| **Inherit** | Walk up to group → collection → integration |
### Source Integrations
Pull APIs directly from:
- **Backstage** — discovers APIs via the Backstage catalog
- **GitHub** — reads OpenAPI specs from repositories
- **GitLab** — reads OpenAPI specs from repositories
Collections from each source appear as separate groups in the sidebar. Changes can be committed back to source control from within the app.
### Environments
- Multiple named environments with key-value variables
- `{{VAR_NAME}}` interpolation in URLs, headers, and body
- Secret variable masking
### Quality of Life
- **Console tab** on every response — structured log of auth source, environment resolution, OAuth token state, SSL settings, and request/response summary
- Per-entity SSL verification (inherit / enabled / disabled)
- Resizable sidebar and response panel
- Search and filter across all collections
- Dark and light theme
- Breadcrumb navigation (Source › Collection › Group › Request)
---
## Download
### macOS
The recommended way to install on macOS is via [Homebrew](https://brew.sh) — it bypasses Gatekeeper automatically:
```bash
brew install dever-labs/tap/postly
```
Alternatively, download the `.dmg` from the [Releases](https://github.com/dever-labs/postly/releases) page. Because Postly is not notarized, macOS will block it on first launch. To allow it, run this once after installing:
```bash
xattr -cr /Applications/Postly.app
```
Or: right-click the app → **Open** → click **Open** in the dialog.
### Windows & Linux
Download the latest installer for your platform from the [Releases](https://github.com/dever-labs/postly/releases) page.
| Platform | Installer |
|---|---|
| Windows x64 | `Postly-Setup-x.x.x.exe` |
| Windows arm64 | `Postly-Setup-x.x.x-arm64.exe` |
| macOS Intel | `Postly-x.x.x.dmg` |
| macOS Apple Silicon | `Postly-x.x.x-arm64.dmg` |
| Linux x64 | `Postly-x.x.x.AppImage` / `.deb` |
| Linux arm64 | `Postly-x.x.x-arm64.AppImage` / `.deb` |
---
## Development
See [docs/development.md](docs/development.md) for full setup instructions.
```bash
# Install dependencies
npm install
# Start dev server (hot reload)
npm run dev
# Build
npm run build
```
---
## Integrations
See [docs/integrations.md](docs/integrations.md) for connecting Backstage, GitHub, and GitLab.
---
## Contributing
1. Fork the repository
2. Create a feature branch: `git checkout -b feat/my-feature`
3. Commit your changes
4. Open a pull request
---
## License
MIT — see [LICENSE](LICENSE)