Skip to content

Commit ad923b6

Browse files
authored
Update tui with new name and details (#79)
1 parent 8399088 commit ad923b6

3 files changed

Lines changed: 42 additions & 44 deletions

File tree

‎crates/tui/README.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# VortexDB TUI
2+
3+
A terminal user interface for managing VortexDB databases locally.
4+
5+
## Important Note
6+
7+
> **This is currently a local admin/development tool**, not a network client. The TUI operates directly on database files using embedded storage — it does not connect to a running VortexDB server. This will change once the server gets the multiple-database support.
8+
>
9+
> For remote server access, use the [Python client](../../client/python/).
10+
11+
## Usage
12+
13+
```bash
14+
cargo run -p tui
15+
```
16+
17+
Databases are stored in `./databases/` by default.
18+
19+
### Environment Variables
20+
21+
For embedding features, set these in your `.env` file or environment:
22+
23+
```bash
24+
TEXT_EMBEDDING_URL=http://localhost:8000/embed/text
25+
IMAGE_EMBEDDING_URL=http://localhost:8000/embed/image
26+
```
27+
28+
These point to an external embedding service that generates vectors from text/images.
29+
30+
## Roadmap
31+
32+
This TUI will evolve into a full client that connects to VortexDB servers over gRPC. Planned changes:
33+
34+
- Add remote connection mode via gRPC (like the Python client)
35+
- Move to `client/tui/` once server multi-database support lands

‎crates/tui/src/ui/components.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ impl PageTitle {
1717
.block(
1818
Block::default()
1919
.borders(Borders::ALL)
20-
.title("Vector DB")
20+
.title("VortexDB")
2121
.title_alignment(Alignment::Center)
2222
.border_style(Style::default().fg(self.color)),
2323
)

‎crates/tui/src/ui/dashboard.rs‎

Lines changed: 6 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -21,74 +21,37 @@ pub fn render_dashboard(f: &mut Frame, app: &App) {
2121
Line::from(""),
2222
Line::from(""),
2323
Line::from(vec![Span::styled(
24-
"██╗ ██╗███████╗ ██████╗████████╗ ██████╗ ██████╗ ",
24+
"██╗ ██╗ ██████╗ ██████╗ ████████╗███████╗██╗ ██╗██████╗ ██████╗ ",
2525
Style::default()
2626
.fg(Color::Cyan)
2727
.add_modifier(ratatui::style::Modifier::BOLD),
2828
)]),
2929
Line::from(vec![Span::styled(
30-
"██║ ██║██╔════╝██╔════╝╚══██╔══╝██╔═══██╗██╔══██╗",
30+
"██║ ██║██╔═══██╗██╔══██╗╚══██╔══╝██╔════╝╚██╗██╔╝██╔══██╗██╔══██╗",
3131
Style::default()
3232
.fg(Color::Cyan)
3333
.add_modifier(ratatui::style::Modifier::BOLD),
3434
)]),
3535
Line::from(vec![Span::styled(
36-
"██║ ██║█████╗ ██║ ██║ ██║ ██║██████╔╝",
36+
"██║ ██║██║ ██║██████╔╝ ██║ █████╗ ╚███╔╝ ██║ ██║██████╔╝",
3737
Style::default()
3838
.fg(Color::Cyan)
3939
.add_modifier(ratatui::style::Modifier::BOLD),
4040
)]),
4141
Line::from(vec![Span::styled(
42-
"╚██╗ ██╔╝██╔══╝ ██║ ██║ ██║ ██║██╔══██╗",
42+
"╚██╗ ██╔╝██║ ██║██╔══██╗ ██║ ██╔══╝ ██╔██╗ ██║ ██║██╔══██╗",
4343
Style::default()
4444
.fg(Color::Cyan)
4545
.add_modifier(ratatui::style::Modifier::BOLD),
4646
)]),
4747
Line::from(vec![Span::styled(
48-
" ╚████╔╝ ███████╗╚██████╗ ██║ ╚██████╔╝██║ ██║",
48+
" ╚████╔╝ ╚██████╔╝██║ ██║ ██║ ███████╗██╔╝ ██╗██████╔╝██████╔╝",
4949
Style::default()
5050
.fg(Color::Cyan)
5151
.add_modifier(ratatui::style::Modifier::BOLD),
5252
)]),
5353
Line::from(vec![Span::styled(
54-
" ╚═══╝ ╚══════╝ ╚═════╝ ╚═╝ ╚═════╝ ╚═╝ ╚═╝",
55-
Style::default()
56-
.fg(Color::Cyan)
57-
.add_modifier(ratatui::style::Modifier::BOLD),
58-
)]),
59-
Line::from(""),
60-
Line::from(vec![Span::styled(
61-
"██████╗ ██████╗ ",
62-
Style::default()
63-
.fg(Color::Cyan)
64-
.add_modifier(ratatui::style::Modifier::BOLD),
65-
)]),
66-
Line::from(vec![Span::styled(
67-
"██╔══██╗██╔══██╗",
68-
Style::default()
69-
.fg(Color::Cyan)
70-
.add_modifier(ratatui::style::Modifier::BOLD),
71-
)]),
72-
Line::from(vec![Span::styled(
73-
"██║ ██║██████╔╝",
74-
Style::default()
75-
.fg(Color::Cyan)
76-
.add_modifier(ratatui::style::Modifier::BOLD),
77-
)]),
78-
Line::from(vec![Span::styled(
79-
"██║ ██║██╔══██╗",
80-
Style::default()
81-
.fg(Color::Cyan)
82-
.add_modifier(ratatui::style::Modifier::BOLD),
83-
)]),
84-
Line::from(vec![Span::styled(
85-
"██████╔╝██████╔╝",
86-
Style::default()
87-
.fg(Color::Cyan)
88-
.add_modifier(ratatui::style::Modifier::BOLD),
89-
)]),
90-
Line::from(vec![Span::styled(
91-
"╚═════╝ ╚═════╝ ",
54+
" ╚═══╝ ╚═════╝ ╚═╝ ╚═╝ ╚═╝ ╚══════╝╚═╝ ╚═╝╚═════╝ ╚═════╝ ",
9255
Style::default()
9356
.fg(Color::Cyan)
9457
.add_modifier(ratatui::style::Modifier::BOLD),

0 commit comments

Comments
 (0)