10 releases (4 breaking)
| 0.15.1 | May 3, 2024 |
|---|---|
| 0.15.0 | May 1, 2024 |
| 0.14.0 | Apr 23, 2024 |
| 0.13.0 | Apr 18, 2024 |
| 0.11.3 | Apr 15, 2024 |
#97 in Web programming
1,289 downloads per month
4.5MB
7K
SLoC
ATAC ⚔📩
Table Of Contents
- Description
- How to install
- Features
- Documentation
- Others
- Technical precisions
- Contributors
- Star history
- License
Description
ATAC is Arguably a Terminal API Client. It is based on well-known clients such as Postman, Insomnia, or even Bruno, but inside your terminal without any specific graphical environment needed.
The philosophy of ATAC is to be free, account-less, and offline for now and forever.
How to install
Install with cargo
[!IMPORTANT] First, make sure your rust version is at least 1.76
Simply use:
cargo install atac
Install from Arch
You can use pacman to install:
pacman -S atac
Install with Homebrew
Simply use:
brew tap julien-cpsn/atac
brew install atac
Install from Fedora copr
Simply use:
dnf enable joxcat/atac
dnf install atac
Binary
The binaries from the latest release can be found here
[!IMPORTANT] Remember to run it from a terminal. For example, you can add the binary into your PATH. You won't be able to run it like other graphical applications since it needs CLI arguments.
[!TIP] Note for macOS users. After downloading the binary you may need to run the command
sudo xattr -rd com.apple.quarantine ~/bin/atac(modify to reflect the path whereatacis located).
Compile by yourself
[!IMPORTANT] First, make sure your rust version is at least 1.76
Simply clone the repository and use:
cargo run
cargo run -- -h
[!TIP] Build the latest release
cargo build --release
Features
Current
| Features | ATAC | Postman | Insomnia |
|---|---|---|---|
| Manage collections & requests | ✅ | ✅ | ✅ |
| HTTP Client | ✅ | ✅ | ✅ |
| Methods | ✅ | ✅ | ✅ |
| - GET | ✅ | ✅ | ✅ |
| - POST | ✅ | ✅ | ✅ |
| - PUT | ✅ | ✅ | ✅ |
| - PATCH | ✅ | ✅ | ✅ |
| - DELETE | ✅ | ✅ | ✅ |
| - HEAD | ✅ | ✅ | ✅ |
| - OPTIONS | ✅ | ✅ | ✅ |
| Authentication | Partial | ✅ | ✅ |
| - Basic auth | ✅ | ✅ | ✅ |
| - Bearer token | ✅ | ✅ | ✅ |
| - JWT, Digest, OAuth1-2, AWS | ❌ 🔜 | ✅ | ✅ |
| Headers | ✅ | ✅ | ✅ |
| Body | ✅ | ✅ | ✅ |
| - Multipart form | ✅ | ✅ | ✅ |
| - URL Encoded form | ✅ | ✅ | ✅ |
| - File | ✅ | ✅ | ✅ |
| - Plain text | ✅ | ✅ | ✅ |
| - JSON, XML, HTML, Javascript | ✅ | ✅ | ✅ |
| Full response | ✅ | ✅ | ✅ |
| - Status code | ✅ | ✅ | ✅ |
| - Cookies | ✅ | ✅ | ✅ |
| - Headers | ✅ | ✅ | ✅ |
| - Duration | ✅ | ✅ | ✅ |
| Scripting | ✅ | Partial | ❌ |
| - Pre-request script | ✅ | ❌ | ❌ |
| - Post-request script | ✅ | ✅ | ❌ |
| Asynchronous requests | ✅ | ✅ | ✅ |
| Per-request settings | ✅ | ✅ | ✅ |
| - Use proxy | ✅ | ✅ | ✅ |
| - Allow redirects | ✅ | ✅ | ✅ |
| - Store cookies | ✅ | ✅ | ✅ |
| Export to other languages | ❌ 🔜 | ✅ | ❌ |
| WebSocket Client | ❌ 🔜 | ✅ | ✅ |
| GraphQL | ❌ 🔜 | ✅ | ✅ |
| gRPC | ❌ 🔜 | ✅ | ✅ |
| MQTT | ❌ 🔜 | ✅ | ❌ |
| Free | ✅ | Depends | Depends |
| Lightweight, fast and efficient | ✅ | ❌ | ❌ |
| Data storage | Your own committable, readable and versioned files (JSON or YAML) | Tied to your account | Tied to your account |
| Offline | ✅ | ❌ | ❌ |
| Real-time collaboration | ❌ (not planned) | ✅ | ✅ |
| Environment files and variables | ✅ (committable, readable and versioned) | ✅ | ✅ |
| View options | ✅ | ✅ | ✅ |
| Global configuration file | ✅ | ✅ | ✅ |
| - HTTP/HTTPS Proxy | ✅ | ✅ | ✅ |
| - Disable CORS | ✅ | ❌ | ❌ |
| - Toggle syntax highlighting | ✅ | ❌ | ❌ |
| Postman v2.1.0 import | ✅ | ✅ | ✅ |
| OpenAPI import | ❌ 🔜 | ✅ | ✅ |
TODO v1.0.0
-
To add
- Create a repo wiki
- Document the whole code
- Command line usage (send requests, add new requests)
- Request body syntax highlighting
- Export a request to other code formats (raw, curl, PHP, JS, Rust, ...)
- OpenAPI & Insomnia import
-
To improve
- Editing cookies
- Auto-completion on env file variables
- Manage multipart Content-type header (auto-generated for now) https://github.com/seanmonstar/reqwest/issues/2259
-
To fix
- Query parameters bug
TODO v2.0.0
- To add
- WebSocket requests
- Maybe GraphQL requests
- Maybe MQTT requests
- Maybe gRPC requests
Ideas (will think about it later)
- Base URL property on collections
Documentation
[!NOTE] Documentation will soon be published in the wiki section
Others
Vim key-bindings
You can read more about it here: https://github.com/Julien-cpsn/ATAC/releases/tag/v0.14.0
NeoVim integration
Thanks to @NachoNievaG you can have an ATAC floating window inside your nvim https://github.com/NachoNievaG/atac.nvim
Technical precisions
Tested on
- Console Host
- Windows 11 (Pro)
- WSL2 Debian
- Windows 10 (Pro)
- Windows 8.1 (N)
- Ubuntu Desktop Terminal
- Ubuntu 17.10
- Pop!_OS 20.04
- (Arch, Manjaro) KDE Konsole
- (Arch, NixOS) Kitty
- Linux Mint
- (OpenSuse) Alacritty
- (Chrome OS) Crostini
(List from here)
Dependencies
| Library | Version | Reason |
|---|---|---|
| reqwest & reqwest cookie store | 0.11.27 & 0.6.0 | Send requests |
| ratatui | 0.26.2 | Terminal UI framework |
| crossterm | 0.27.0 | Terminal Backend |
| crokey | 0.6.4 | Used to parse, use key bindings files and some utilities |
| tui-big-text | 0.4.2 | Display big texts. Only used for displaying ATAC in the homepage. |
| tui-tree-widget | 0.19.0 | Display tree-like lists. Used for displaying the collections. |
| tui-textarea | 0.5.0 | Text area that handle a lot of features. Used for editing request body. |
| throbber-widgets-tui | 0.4.1 | Display loading UI elements. Used when request is pending. |
| ratatui-image | 1.0.0 | Display response images. |
| image | 0.24.9 | Decode images. |
| syntect | 5.2.0 | Syntax highlighting |
| serde (serde_json, serde-yaml) | 1.0.197 (1.0.144, 0.9.34) | Serialize & Deserialize application data into files |
| jsonxf | 0.1.1 | Pretty print JSON |
| toml | 0.8.11 | Serialize & Deserialize application config files |
| boa_engine | 0.18.0 | Create Javascript runtimes. Used for pre and post request scripts |
| My fork of postman_collection | 0.2.1 | Deserialize Postman collection files |
| clap | 4.5.0 | Command Line Argument Parser |
| arboard | 3.3.2 | Copy response body to clipboard |
| tokio | 1.0.0 | Handle asynchronous requests |
| parking_lot | 0.12.2 | Smaller, faster and more flexible implementation of RwLock and Mutex. Used everywhere. |
| strum | 0.26.2 | Enum facilities |
| lazy_static | 1.4.0 | Allows for more flexible constants. Mainly used for accessing CLI arguments everywhere |
| nestify | 0.3.3 | Used to nest struct definitions |
| snailquote | 0.3.1 | Unescape string |
| indexmap | 2.2.6 | Ordered hashmap. Used in environments to preserve files' values order |
| base64 | 0.22.0 | Encode auth. |
| regex | 1.10.3 | Regex. Using for parsing requests URL |
Binary size
The binary file size goes from ~4.5 MB to ~7 MB depending on the platform. I try to keep it as small as possible.
Contributors
Maintainers
Packagers
- Cargo, Brew - @julien-cpsn
- Arch - @orhun
- Fedora copr - @joxcat
Star history
License
The MIT license for this project can be seen here
Dependencies
~49–68MB
~1M SLoC