Hulunote TUI

A terminal-based user interface client for Hulunote, an outliner note-taking application. Built with Rust using the Ratatui framework.

• Full Hulunote Integration: Login, manage databases, notes, and outline navigation
• Vim-style Navigation: Use j/k for movement, gg/G for jumping, h/l for expand/collapse
• Outline Editing: Create, edit, delete, and reorganize outline nodes
• Command Palette: Quick access to all actions via Ctrl+P
• Search: Find notes across all databases with Ctrl+S or /
• Persistent Login: Automatically saves your session token
• Monokai Pro Theme: Beautiful dark theme optimized for black terminal backgrounds

Hulunote TUI uses the Monokai Pro color scheme, featuring:

Background: #2d2a2e (dark gray)

• Rust toolchain (1.70+)
• A running Hulunote server
• Terminal with Nerd Font support (for icons)

git clone https://github.com/your-repo/hulunote-tui.git
cd hulunote-tui
cargo build --release

• or cargo run

cargo run -- --server https://www.hulunote.top/

The binary will be located at target/release/hulunote-tui.

cargo install --path .

# Connect to default server (localhost:6689)
hulunote-tui

# Connect to a specific server
hulunote-tui --server http://your-server:6689
# or
hulunote-tui -s http://your-server:6689

The command palette (Ctrl+P) supports the following commands:

Configuration files are stored in ~/.hulunote/:

{
  "server_url": "http://localhost:6689"
}

Enter your Hulunote email and password to authenticate. Use Tab to switch between email and password fields.

View and manage your Hulunote databases. Select a database to view its notes.

Browse notes within the selected database. Notes marked as shortcuts are highlighted with a star icon.

The main editing interface. View and edit the hierarchical outline structure of your notes with full tree navigation and manipulation.

Search across all notes in all databases. Results show matching note titles.

src/
├── main.rs          # Application entry point and event loop
├── app.rs           # Application state and business logic
├── config.rs        # Configuration management
├── event.rs         # Keyboard event handling and text input
├── api/             # API client modules
│   ├── client.rs    # HTTP client wrapper
│   ├── auth.rs      # Authentication endpoints
│   ├── database.rs  # Database management endpoints
│   ├── note.rs      # Note management endpoints
│   └── nav.rs       # Outline navigation endpoints
├── models/          # Data structures
└── ui/              # UI rendering modules
    ├── mod.rs       # Main UI renderer
    ├── theme.rs     # Monokai Pro color theme
    ├── login.rs     # Login screen
    ├── database_list.rs  # Database list screen
    ├── note_list.rs      # Note list screen
    ├── outline.rs   # Outline editor screen
    ├── search.rs    # Search screen
    ├── help.rs      # Help overlay
    └── command.rs   # Command palette

• ratatui: Terminal UI framework
• crossterm: Cross-platform terminal manipulation
• tokio: Async runtime
• reqwest: HTTP client
• serde/serde_json: JSON serialization
• clap: Command line argument parsing
• anyhow: Error handling

If you see connection errors:

1. Verify the Hulunote server is running
2. Check the server URL is correct (avoid using 0.0.0.0 as client address)
3. Ensure no proxy software (like ClashX) is intercepting local connections

If login fails or you get "Authentication failed":

1. Clear the saved token: rm ~/.hulunote/token
2. Try logging in again with correct credentials

If the UI doesn't render correctly:

1. Ensure your terminal supports 256 colors or True Color (24-bit)
2. Use a terminal with Nerd Font installed for proper icon display
3. Try resizing your terminal window
4. Recommended terminals: iTerm2, Alacritty, Kitty, WezTerm

This app uses Nerd Font icons. If you see boxes or question marks:

1. Install a Nerd Font
2. Set your terminal to use the Nerd Font
3. Popular choices: JetBrainsMono Nerd Font, FiraCode Nerd Font, Hack Nerd Font

This project is licensed under the MIT License - see the LICENSE file for details.

Contributions are welcome! Please feel free to submit a Pull Request.