Skip to content

Commit 4a1e8b1

Browse files
committed
v0.3.0: interactive settings TUI, sub-resource editing, reference docs
- Add interactive settings TUI (`settings edit -i`) with checkbox, reorder, string list, select, number, and JSON editors for all 21 sub-resources - Add sub-resource editing (`settings edit <index> synonyms`) in $EDITOR - Preserve JSON field ordering from server (serde_json preserve_order) - Add README screenshots for search, chat, and settings TUIs - Add comprehensive CLI reference at docs/reference.md
1 parent 506220d commit 4a1e8b1

12 files changed

Lines changed: 2414 additions & 11 deletions

CHANGELOG.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,18 @@
11
# Changelog
22

3+
## [0.3.0] - 2026-04-11
4+
5+
### Added
6+
7+
- **Interactive settings TUI**: `meilisearch settings edit <index> -i` opens a full TUI for managing all 21 settings sub-resources with checkbox editors, reordering, string list editing, select menus, and number inputs
8+
- **Sub-resource editing**: `meilisearch settings edit <index> synonyms` opens `$EDITOR` on a single sub-resource instead of the full settings blob
9+
- **CLI reference documentation**: comprehensive `docs/reference.md` covering all 24 commands, 42+ subcommands, every argument, flag, and default value
10+
- **README screenshots**: interactive search, chat, settings overview, and settings editor screenshots
11+
12+
### Fixed
13+
14+
- **JSON field ordering**: search results and settings now preserve server field order instead of sorting alphabetically (serde_json `preserve_order` feature)
15+
316
## [0.2.0] - 2026-04-11
417

518
### Added

Cargo.lock

Lines changed: 2 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "meilisearch-cli"
3-
version = "0.2.0"
3+
version = "0.3.0"
44
edition = "2024"
55
description = "The official Meilisearch CLI"
66
license = "MIT"
@@ -24,7 +24,7 @@ indicatif = "0.18"
2424
ratatui = { version = "0.30", features = ["unstable-rendered-line-info"] }
2525
reqwest = { version = "0.13", features = ["json", "stream", "multipart"] }
2626
serde = { version = "1", features = ["derive"] }
27-
serde_json = "1"
27+
serde_json = { version = "1", features = ["preserve_order"] }
2828
tar = "0.4"
2929
tempfile = "3"
3030
tokio = { version = "1", features = ["full"] }

README.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,25 @@
11
# Meilisearch CLI
22

3-
The official Meilisearch CLI — a single Rust binary that covers everything from day-to-day instance management to advanced data operations, with an interactive TUI mode for search and chat.
3+
The official Meilisearch CLI — a single Rust binary that covers everything from day-to-day instance management to advanced data operations, with an interactive TUI mode for search, chat, and settings.
4+
5+
<table>
6+
<tr>
7+
<td><strong>Interactive Search</strong></td>
8+
<td><strong>Interactive Chat</strong></td>
9+
</tr>
10+
<tr>
11+
<td><img src="assets/interactive-search.png" alt="Interactive search TUI" width="400"></td>
12+
<td><img src="assets/interactive-chat.png" alt="Interactive chat TUI" width="400"></td>
13+
</tr>
14+
<tr>
15+
<td><strong>Settings Overview</strong></td>
16+
<td><strong>Settings Editor</strong></td>
17+
</tr>
18+
<tr>
19+
<td><img src="assets/interactive-settings.png" alt="Interactive settings overview" width="400"></td>
20+
<td><img src="assets/interactive-settings-edit.png" alt="Interactive settings field editor" width="400"></td>
21+
</tr>
22+
</table>
423

524
## Installation
625

@@ -97,6 +116,8 @@ meilisearch settings get <uid>
97116
meilisearch settings update <uid> --file settings.json
98117
meilisearch settings reset <uid>
99118
meilisearch settings edit <uid> # opens $EDITOR
119+
meilisearch settings edit <uid> -i # interactive TUI
120+
meilisearch settings edit <uid> synonyms # edit sub-resource in $EDITOR
100121
meilisearch settings diff <uid>
101122
```
102123

assets/interactive-chat.png

271 KB
Loading

assets/interactive-search.png

261 KB
Loading
124 KB
Loading

assets/interactive-settings.png

208 KB
Loading

0 commit comments

Comments
 (0)