https://github.com/rlelf/revw
A vim-like TUI for managing notes and resources
https://github.com/rlelf/revw
Last synced: 5 months ago
JSON representation
A vim-like TUI for managing notes and resources
- Host: GitHub
- URL: https://github.com/rlelf/revw
- Owner: rlelf
- License: mit
- Created: 2025-09-05T03:09:43.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-10-19T10:37:42.000Z (5 months ago)
- Last Synced: 2025-10-22T02:57:59.080Z (5 months ago)
- Language: Rust
- Homepage:
- Size: 2.71 MB
- Stars: 13
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ratatui - revw - A vim-like TUI for managing notes and resources. (💻 Apps / 🚀 Productivity and Utilities)
README
# Revw
[](https://crates.io/crates/revw)
[](https://opensource.org/licenses/MIT)
[](https://github.com/rlelf/revw)
[](https://ratatui.rs/)
A vim-like TUI for managing notes and resources.
## Features
- Vim-like terminal user interface
- Clipboard integration
- Clean card-based interface
- Toggle between View mode and raw JSON mode
## Relf Format
### Outside
External resources and references:
- **Name**: Title or identifier of the resource
- **Context**: Description or notes about the resource
- **URL**: Web address or link
- **Percentage**: Score or progress indicator, sortable for ordering
### Inside
Internal notes or thoughts with timestamps:
- **Date**: Timestamp of the entry, sortable for ordering
- **Context**: notes or thoughts
```json
{
"outside": [
{
"name": "Rust Programming Language",
"context": "A systems programming language focused on safety, speed, and concurrency.",
"url": "https://www.rust-lang.org/",
"percentage": 100
}
],
"inside": [
{
"date": "2025-01-01 00:00:00",
"context": "Finally learned how to use cargo! Running 'cargo new my_project' creates such a clean project structure."
}
]
}
```
This format is also available in [relf](https://github.com/rlelf/relf)
## Install
```bash
cargo install revw
```
Or install from source:
```bash
cargo install --git https://github.com/rlelf/revw.git --locked
```
Or download from [Releases](https://github.com/rlelf/revw/releases)
## Usage
### Notes and resources Management
Track learning resources, books, articles, and tools you're exploring.
### Learning diary
Document your daily learning progress with timestamped notes.
### LLM-Assisted Workflows
Revw integrates seamlessly with AI assistants:
**Workflow 1: LLM generates → You review**
1. Ask an LLM to generate a reading list or resource collection
2. Paste the JSON into Revw (`:v` key)
3. Browse and organize visually
**Workflow 2: You create → LLM assists**
1. Maintain your notes in Revw's clean interface
2. Copy sections to clipboard (`:c`, `:ci`, `:co`)
3. Share with LLM for analysis, summarization, or questions
### Command Line Options
```bash
# View help
revw --help
# Show version
revw --version
# Start without file
revw
# View mode
revw file.json
# Edit mode
revw --json file.json
# Output to stdout
revw --stdout file.json
# Output to file
revw --output output.txt file.json
# Output only INSIDE section
revw --stdout --inside file.json
# Output only OUTSIDE section
revw --stdout --outside file.json
```
## Controls
### View Mode
**Navigation:**
- `j/k` or `↑/↓` select card (or mouse wheel)
- `gg` select first card
- `G` select last card
- `:gi` jump to first INSIDE entry
- `:go` jump to first OUTSIDE entry
- `/` search forward
- `n/N` next/prev match (jumps to card)
- `:noh` clear search highlighting
**Editing:**
- `Enter` open edit overlay for selected card
- `:ai` add new INSIDE entry (jumps to it)
- `:ao` add new OUTSIDE entry (jumps to it)
- `:dd` delete selected entry (entire object)
- `:yy` duplicate selected entry (entire object)
- `:o` order entries (by percentage then name) and auto-save
- `:op` order by percentage only and auto-save
- `:on` order by name only and auto-save
- `:f pattern` filter entries by pattern
**Visual Mode (multi-card selection):**
- `v` enter Visual mode
- `j/k` extend selection
- `:cc` copy selected cards (rendered format)
- `:ccj` copy selected cards (JSON format)
- `:dc` delete selected cards
- `Esc` or `Ctrl+[` exit Visual mode
**Copy/Paste:**
- `:c` copy all rendered content (with OUTSIDE/INSIDE headers)
- `:ci` copy INSIDE section only
- `:co` copy OUTSIDE section only
- `:cu` copy URL from selected card
- `:v` paste file path or JSON content
- `:vu` paste URL from clipboard to selected card
- `:vi` paste INSIDE from clipboard (overwrite)
- `:vo` paste OUTSIDE from clipboard (overwrite)
- `:va` paste both INSIDE and OUTSIDE from clipboard (append)
- `:vai` paste INSIDE from clipboard (append)
- `:vao` paste OUTSIDE from clipboard (append)
- `:xi` clear INSIDE section
- `:xo` clear OUTSIDE section
**Filter:**
- `:f pattern` filter entries by pattern
- `:nof` clear filter
**Settings:**
- `:set number` or `:set nu` enable line numbers (Edit mode)
- `:set nonumber` or `:set nonu` disable line numbers
- `:set card=N` set max visible cards (1-10, default: 5)
**Other:**
- `r` toggle View/Edit mode
- `:Lexplore` or `:Lex` or `:lx` toggle file explorer
- `:x` clear content
- `:h` or `?` toggle help mode
- `q` or `Esc` quit
**File Explorer:**
- `j/k` or `↑/↓` navigate files/directories
- `Enter` open file (JSON only) or enter directory
- `:Lexplore` or `:Lex` or `:lx` close explorer
- `Ctrl+w w` cycle between explorer and file window
- `Ctrl+w h` move to explorer window (left)
- `Ctrl+w l` move to file window (right)
**Explorer File Operations (when explorer has focus):**
- `Enter` or `o` open file or navigate into directory
- `:a` create new JSON file in current directory
- `:d` create new directory
- `:m` rename/move selected file/directory (supports relative paths like `./folder/file.json`, or just `newname.json`)
- `:dd` delete selected file (confirms with yes/no)
- `:yy` copy selected file (prompts for new filename)
#### Edit Overlay
**Field Selection Mode (default):**
- `j/k` or `↑/↓` navigate between fields
- `Enter` enter field editing mode (shows cursor)
- `i` enter insert mode directly
- `v` enter View Edit mode (renders `\n` as newlines)
- `w` save changes
- `Esc` or `q` cancel
**Field Editing Mode:**
- `h/l` or `←/→` move cursor left/right
- `0` move to start of field
- `$` move to end of field
- `w` next word
- `b` previous word
- `e` end of word
- `g` or `gg` jump to start
- `G` jump to end
- `i` enter insert mode
- `x` delete character at cursor
- `X` delete character before cursor
- `Esc` or `Ctrl+[` exit to field selection mode
**Insert Mode:**
- Type to edit text
- `←/→` move cursor
- `Backspace` delete character
- `Esc` or `Ctrl+[` exit to field editing mode
**View Edit Mode (from Field Selection):**
- `v` enter View Edit mode (renders `\n` as newlines, yellow text)
- Type to edit text (h/j/k/l are text input, not navigation)
- `↑/↓` move between lines
- `←/→` move cursor
- `Enter` insert `\n` (literal newline)
- `Backspace` delete character (or `\n` together)
- `Esc` or `Ctrl+[` exit to field selection mode
### Edit Mode
**Navigation:**
- `h/j/k/l` or arrow keys - move cursor
- `w` next word start
- `e` next word end
- `b` previous word start
- `0` move to start of line
- `$` move to end of line
- `gg` jump to top
- `G` jump to bottom
- `:gi` jump to first INSIDE entry
- `:go` jump to first OUTSIDE entry
- Mouse wheel - scroll (drag disabled)
**Editing:**
- `i` enter insert mode
- `x` delete character at cursor
- `X` delete character before cursor
- `Esc` or `Ctrl+[` exit insert mode
- `:dd` delete current entry (entire object)
- `:yy` duplicate current entry (entire object)
- `u` undo
- `Ctrl+r` redo
- `g-` undo
- `g+` redo
**Search:**
- `/` search forward
- `n/N` next/prev match
- `:noh` clear search highlighting
**Commands:**
- `:ai` add INSIDE entry
- `:ao` add OUTSIDE entry
- `:o` order entries (by percentage then name)
- `:op` order by percentage only
- `:on` order by name only
- `:dd` delete current entry (entire object)
- `:yy` duplicate current entry (entire object)
- `:c` copy all content
- `:ci` copy INSIDE section (JSON format)
- `:co` copy OUTSIDE section (JSON format)
- `:v` paste from clipboard
- `:vi` paste INSIDE from clipboard (overwrite)
- `:vo` paste OUTSIDE from clipboard (overwrite)
- `:va` paste both INSIDE and OUTSIDE from clipboard (append)
- `:vai` paste INSIDE from clipboard (append)
- `:vao` paste OUTSIDE from clipboard (append)
- `:x` clear all content
- `:xi` clear INSIDE section
- `:xo` clear OUTSIDE section
- `:nof` clear filter
- `:w` save
- `:wq` save and quit
- `:q` quit
- `:e` reload file
- `:ar` toggle auto-reload (default: on)
- `:Lexplore` or `:Lex` or `:lx` toggle file explorer
- `Ctrl+w w` cycle between explorer and file window
- `Ctrl+w h` move to explorer window (left)
- `Ctrl+w l` move to file window (right)
- `:h` or `?` help
**Settings:**
- `:set number` or `:set nu` enable line numbers
- `:set nonumber` or `:set nonu` disable line numbers
- `:set card=N` set max visible cards (1-10, default: 5)
**Substitute:**
- `:s/foo/bar/` substitute first occurrence in current line
- `:s/foo/bar/g` substitute all occurrences in current line
- `:%s/foo/bar/` substitute first occurrence in all lines
- `:%s/foo/bar/g` substitute all occurrences in all lines
## Configuration
Revw can be configured using a `.revwrc` file in your home directory (`~/.revwrc`).
### Configuration Options
**Line Numbers:**
```vim
set number # Enable line numbers (Edit mode)
set nonumber # Disable line numbers (default)
```
**Max Visible Cards:**
```vim
set card=5 # Set max visible cards (1-10, default: 5)
```
**Color Schemes:**
```vim
colorscheme Default # Default color scheme
```
You can also change the color scheme at runtime using `:colorscheme `.
**Available themes:** Default, Morning, Evening, Pablo, Ron, Blue
### Example `.revwrc`
```vim
# Example configuration
colorscheme Default
set number
set card=5
```
## Changelog
See [CHANGELOG](https://github.com/rlelf/revw/blob/main/CHANGELOG.md) for version history and changes.
## License
MIT