postboy-tui 1.0.6 → 1.0.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +12 -39
- package/dist/cli +0 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -9,7 +9,6 @@ A modern, terminal-based API testing and development tool with a clean TUI (Text
|
|
|
9
9
|
- [Features](#features)
|
|
10
10
|
- [Installation](#installation)
|
|
11
11
|
- [Usage](#usage)
|
|
12
|
-
- [Screenshots](#screenshots)
|
|
13
12
|
- [Feature Details](#feature-details)
|
|
14
13
|
- [Contributing](#contributing)
|
|
15
14
|
- [License](#license)
|
|
@@ -45,52 +44,32 @@ npm install
|
|
|
45
44
|
|
|
46
45
|
## Usage
|
|
47
46
|
|
|
48
|
-
###
|
|
47
|
+
### Install the app
|
|
49
48
|
|
|
50
49
|
```bash
|
|
50
|
+
npm i -g postboy-tui@latest
|
|
51
|
+
#or
|
|
52
|
+
bun i -g postboy-tui@latest
|
|
51
53
|
# Start the TUI (Text User Interface)
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
# Or with npm
|
|
55
|
-
npm start -- ui
|
|
54
|
+
postboy-tui ui
|
|
56
55
|
```
|
|
57
56
|
|
|
58
57
|
### CLI Commands
|
|
59
58
|
|
|
60
59
|
- **Launch TUI interface:**
|
|
61
60
|
```bash
|
|
62
|
-
|
|
63
|
-
# or, if installed globally:
|
|
64
|
-
postboy ui
|
|
61
|
+
postboy-tui ui
|
|
65
62
|
```
|
|
66
63
|
|
|
67
64
|
- **Send a test API request (interactive prompt):**
|
|
68
65
|
```bash
|
|
69
|
-
|
|
70
|
-
# or
|
|
71
|
-
postboy test
|
|
66
|
+
postboy-tui test
|
|
72
67
|
```
|
|
73
68
|
|
|
74
69
|
- **List available mock API endpoints:**
|
|
75
70
|
```bash
|
|
76
|
-
|
|
77
|
-
# or
|
|
78
|
-
postboy mock-list
|
|
71
|
+
postboy-tui mock-list
|
|
79
72
|
```
|
|
80
|
-
|
|
81
|
-
### Build and Install Globally (Optional)
|
|
82
|
-
|
|
83
|
-
To use the `postboy` command anywhere:
|
|
84
|
-
|
|
85
|
-
```bash
|
|
86
|
-
bun run build
|
|
87
|
-
bun add -g .
|
|
88
|
-
# Now you can use:
|
|
89
|
-
postboy ui
|
|
90
|
-
postboy test
|
|
91
|
-
postboy mock-list
|
|
92
|
-
```
|
|
93
|
-
|
|
94
73
|
---
|
|
95
74
|
|
|
96
75
|
## Feature Details
|
|
@@ -134,14 +113,14 @@ View responses in a pretty-printed format. Supports JSON, XML, and raw text. Syn
|
|
|
134
113
|
### 5. Theming
|
|
135
114
|
|
|
136
115
|
Switch between light and dark themes to suit your preference.
|
|
137
|
-
|
|
138
|
-
> _Screenshot: Theming_
|
|
116
|
+
<img width="1145" height="912" alt="image" src="https://github.com/user-attachments/assets/c87c1484-0d59-4f29-9132-6783c8cc1e15" />
|
|
139
117
|
|
|
140
118
|
---
|
|
141
119
|
|
|
142
|
-
### 6. Mock
|
|
120
|
+
### 6. Mock APIs list
|
|
143
121
|
|
|
144
|
-
|
|
122
|
+
- categorized mock api lists
|
|
123
|
+
- get a bunch of mock apis for testing the clients under development.
|
|
145
124
|
|
|
146
125
|
---
|
|
147
126
|
|
|
@@ -175,12 +154,6 @@ Contributions are welcome! Please open issues or submit pull requests for new fe
|
|
|
175
154
|
|
|
176
155
|
---
|
|
177
156
|
|
|
178
|
-
## License
|
|
179
|
-
|
|
180
|
-
[MIT](./LICENSE)
|
|
181
|
-
|
|
182
|
-
---
|
|
183
|
-
|
|
184
157
|
## Contact
|
|
185
158
|
|
|
186
159
|
For support, questions, or feedback, please open an issue or contact the maintainer.
|
package/dist/cli
CHANGED
|
Binary file
|