README.md 3.5 K raw
1
# cielago
2
3
![cover](https://files.stevedylan.dev/cielago-demo.jpg)
4
5
Like Postman but it actually works. Terminal native HTTP request builder with OpenAPI support.
6
7
[Video Overview](https://www.youtube.com/watch?v=Jv6O-_WH3N8)
8
9
</details>
10
11
## Features
12
13
- **OpenAPI 3.x import** — turn a spec (file or URL) into a collection with requests, params, example bodies, servers, and docs prefilled.
14
- **Ad-hoc collections** — no spec needed; paste a full URL and it's split into server, path, and query params for you.
15
- **Vim-style TUI** — three panes (requests / editor / response), `j`/`k` navigation, `:` command line, `/` incremental search.
16
- **Variables** — `{{name}}` from the collection, plus dynamic ones like `{{uuid}}`, `{{timestamp}}`, `{{randomInt(1,100)}}`.
17
- **Auth per collection** — a fixed bearer token, an API key in a header of your choice, or the OAuth2 client-credentials flow (tokens cached in memory only). Press `A` to configure.
18
- **Secrets from your shell** — any secret field (bearer token, API key, OAuth client secret) can be a `$(…)` command, resolved at send time, e.g. `$(op read "op://vault/item/field")`.
19
- **Server switcher** — swap base URLs so requests stay portable across envs.
20
- **Syntax highlighting** — JSON and XML in both request bodies and responses.
21
- **Plain JSON storage** — collections live in `~/.config/cielago/collections/`.
22
23
## Installation
24
25
### Homebrew
26
27
```sh
28
brew install stevedylandev/tap/cielago
29
```
30
31
### Cargo 
32
33
```bash
34
cargo install cielago
35
```
36
37
### Prebuilt binaries
38
39
Grab a binary for your platform from the [releases page](https://github.com/stevedylandev/cielago/releases), or run the install script:
40
41
```sh
42
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/stevedylandev/cielago/releases/latest/download/cielago-installer.sh | sh
43
```
44
45
### From source
46
47
```sh
48
cargo install --path .
49
```
50
51
Or build without installing:
52
53
```sh
54
cargo build --release
55
./target/release/cielago --help
56
```
57
58
## Usage
59
60
```sh
61
cielago                          # open the last-used collection in the TUI
62
cielago open [name]              # open a specific collection
63
cielago import <spec|url>        # import an OpenAPI 3.x spec
64
cielago new <name> [--server u]  # create an empty collection and open it
65
cielago list [-l]                # list collections (-l adds counts + paths)
66
cielago info <name>              # servers, counts, auth, groups
67
cielago edit <name>              # edit the collection JSON in $EDITOR
68
cielago rename <name> <new>      # rename a collection and its file
69
cielago delete <name> [-f]       # delete a collection
70
cielago path <name>              # print the collection's JSON path
71
```
72
73
`<name>` matches loosely — `Some API`, `some api`, and `some-api` all resolve to the same collection.
74
75
### Keys
76
77
| Key | Action |
78
|---|---|
79
| `1`/`2`/`3`, `Tab` | Focus sidebar / editor / response |
80
| `z` | Maximize focused pane |
81
| `[` / `]` | Previous / next editor tab |
82
| `Enter` | Send request |
83
| `/` | Search requests |
84
| `E` / `A` | Servers / OAuth config |
85
| `:` | Command line (`:w`, `:q`, `:new`, `:open`, …) |
86
| `?` | Help |
87
88
| Context | Keys |
89
|---|---|
90
| Sidebar | `n`/`r`/`d`/`y` new/rename/delete/duplicate, `t` cycle label source |
91
| Tables | `space` toggle row, `i` edit, `a` add, `d` delete, `m` cycle method, `p` edit URL |
92
| Body/response | `e` open in `$EDITOR`, `j`/`k`/`d`/`u`/`g`/`G` scroll |
93
94
Press `?` in the TUI for the full list.
95
96
## Development
97
98
```sh
99
cargo build
100
cargo test
101
cargo clippy --all-targets
102
cargo fmt
103
```
104
105
## License
106
107
[MIT](LICENSE)