Skip to content

Commit c8e9bb5

Browse files
author
codevalve
committed
docs: finalized v2.0.0 documentation and roadmap
1 parent c72185c commit c8e9bb5

3 files changed

Lines changed: 25 additions & 11 deletions

File tree

README.md

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,23 @@ brew install rapide
1717
go install github.com/codevalve/rapide@latest
1818
```
1919

20+
## Interactive TUI 🗿
21+
22+
Rapide v2.0 introduces a state-of-the-art Terminal User Interface. Run it with:
23+
24+
```bash
25+
rapide tui
26+
```
27+
28+
### Key Hotkeys
29+
- **`/`**: Real-time filtering (search by content, collection, or ID)
30+
- **`n`**: Create a new entry without leaving the TUI
31+
- **`d`**: Toggle task completion (`x`)
32+
- **`m`**: Migrate task to today (`>`)
33+
- **`x`**: Delete entry
34+
- **`T`**: Surgical trim (archive/delete entries before a specific date)
35+
- **`q`**: Quit
36+
2037
## Usage
2138

2239
### Logging
@@ -27,27 +44,22 @@ Syntax: `rapide [margin-key] | [bullet] content [!]`
2744
- **Note (`-`)**: `rapide "- Review PR"`
2845
- **Event (`O`)**: `rapide "O Meeting @ 2pm"`
2946
- **Priority**: Append `!` to any entry to mark it important.
30-
31-
**Examples:**
32-
```bash
33-
rapide "work | - Finished the first draft of the Go port!"
34-
rapide "personal | O Lunch with the team!"
35-
rapide "• Fix the login bug!!"
36-
```
47+
- **Short IDs**: Every entry has a unique 4-character ID (displayed in `list` and `tui`).
3748

3849
### Commands
3950

4051
| Command | Usage | Description |
4152
| :--- | :--- | :--- |
53+
| **`tui`** | `rapide tui` | **New!** Enter the interactive terminal interface |
4254
| **`list`** | `rapide list [today/3d/work]` | List entries (filtered by time or collection) |
4355
| **`done`** | `rapide done <id>` | Mark a task as completed (`x`) |
4456
| **`migrate`** | `rapide migrate <id>` | Move a task to today and mark original as migrated (`>`) |
4557
| **`unfinished`**| `rapide unfinished` | List all non-completed tasks (``) |
4658
| **`collections`**| `rapide collections` | See list of margin keys and item counts |
47-
| **`search`** | `rapide search <query>` | Search all entries for a keyword |
59+
| **`search`** | `rapide search <query>` | Search all entries for a keyword or ID |
4860
| **`edit`** | `rapide edit <id> <text>` | Update the content of an existing entry |
4961
| **`delete`** | `rapide delete <id>` | Permanently remove an entry |
50-
| **`trim`** | `rapide trim [--before YYYY-MM-DD]` | Archive or delete old logs to keep it clean |
62+
| **`trim`** | `rapide trim [--before DATE]` | Archive or delete old logs with confirmation |
5163
| **`version`** | `rapide version` | Show current version |
5264

5365
#### Command Details

ROADMAP.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This document outlines the planned trajectory for Rapide beyond the initial local CLI release.
44

5-
## v2.0.0: Interactive TUI
5+
## v2.0.0: Interactive TUI (Released 🗿🚀)
66
The goal is to transition Rapide from a purely command-driven tool to an interactive experience for reviewing and managing logs.
77

88
- **Infrastructure**: Implement a Terminal User Interface (TUI) using [Charm Bubble Tea](https://github.com/charmbracelet/bubbletea) and [Charm Lipgloss](https://github.com/charmbracelet/lipgloss).

cmd/tui.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@ import (
1212
var tuiCmd = &cobra.Command{
1313
Use: "tui",
1414
Short: "Launch the interactive Rapanui TUI",
15-
Long: `Provide a full terminal interface for browsing and managing your BuJo logs.`,
15+
Long: `Enter a state-of-the-art interactive terminal interface for Rapide.
16+
Browse entries, filter in real-time (/), create new items (n),
17+
and manage your log with fast hotkeys (d, m, x, T).`,
1618
Run: func(cmd *cobra.Command, args []string) {
1719
p := tea.NewProgram(tui.InitialModel(), tea.WithAltScreen())
1820
if _, err := p.Run(); err != nil {

0 commit comments

Comments
 (0)