Usage Guide

Features Overview

  • 🌲 Interactive Tree Navigation: Browse LDAP directory structure with keyboard/mouse
  • 📄 Record Viewer: View detailed LDAP entry attributes
  • 📋 Clipboard Integration: Copy attribute values to system clipboard
  • 🔍 Custom Query Interface: Execute custom LDAP queries with real-time results
  • 📖 Paginated Results: Efficient pagination for large result sets with automatic loading
  • ⚙️ Flexible Configuration: Support for config files and command-line options
  • 🔐 Secure Authentication: Support for SSL/TLS and various authentication methods
  • 🔄 Auto-Update Notifications: Optional checking for newer releases from GitHub
  • 🎨 Modern TUI: Clean, intuitive interface built with BubbleTea
  • 🔀 Multiple Connections: Save and switch between multiple LDAP server configurations

Command Line Options

# Connect with command line options
moribito --host ldap.example.com --port 389 --base-dn "dc=example,dc=com"

# Use SSL/TLS
moribito --host ldap.example.com --ssl --base-dn "dc=example,dc=com"

# With authentication
moribito --host ldap.example.com --bind-user "cn=admin,dc=example,dc=com" --bind-password "password" --base-dn "dc=example,dc=com"

# Enable auto-update checking
moribito --check-updates

# Combine options
moribito --host ldap.example.com --ssl --check-updates --base-dn "dc=example,dc=com"

Configuration File

Create a YAML configuration file to avoid typing connection details repeatedly:

Basic Configuration (Single Connection)

# ~/.moribito.yaml or ./config.yaml
ldap:
    host: ldap.example.com
    port: 389
    base_dn: dc=example,dc=com
    use_ssl: false
    use_tls: true
    bind_user: cn=admin,dc=example,dc=com
    bind_pass: password
pagination:
    page_size: 100

Creating Configuration Files

You can create a configuration file in several ways:

  1. Automatic Creation: Use the --create-config flag to create a default configuration file:

    moribito --create-config

  2. UI Configuration: Configure settings through the start screen interface. All changes made in the UI are automatically saved to the config file.

  3. Manual Creation: Create a YAML file manually at one of these locations:

    • Linux/macOS: ~/.config/moribito/config.yaml or ~/.moribito.yaml
    • Windows: %APPDATA%\moribito\config.yaml or %USERPROFILE%\.moribito.yaml
    • Current Directory: ./config.yaml

Note: Configuration changes made through the UI (Start View) are automatically saved to the config file and persist across application restarts.

Advanced Configuration (Multiple Saved Connections)

For environments with multiple LDAP servers, you can save multiple connection profiles:

ldap:
    # Default connection settings (used when no saved connections exist)
    host: ldap.example.com
    port: 389
    base_dn: dc=example,dc=com
    use_ssl: false
    use_tls: true
    bind_user: cn=admin,dc=example,dc=com
    bind_pass: password

    # Multiple saved connections
    selected_connection: 0 # Index of currently active connection (-1 for default)
    saved_connections:
        - name: "Production"
          host: ldap.prod.example.com
          port: 636
          base_dn: dc=prod,dc=example,dc=com
          use_ssl: true
          use_tls: false
          bind_user: cn=admin,dc=prod,dc=example,dc=com
          bind_pass: prod-password

        - name: "Development"
          host: ldap.dev.example.com
          port: 389
          base_dn: dc=dev,dc=example,dc=com
          use_ssl: false
          use_tls: true
          bind_user: cn=admin,dc=dev,dc=example,dc=com
          bind_pass: "" # Will prompt for password

pagination:
    page_size: 50
retry:
    enabled: true
    max_attempts: 3

Then simply run:

moribito -config ~/.moribito.yaml

Managing Multiple Connections

When using multiple saved connections:

  1. In the Start View: Navigate to the “Saved Connections” section to:

    • Switch between saved connections using ←/→ arrow keys
    • Add new connections with “Add New Connection”
    • Delete connections with “Delete Connection”
    • Save current settings as a new connection

  2. Connection Selection: The selected_connection field determines which saved connection is active:

    • -1 or omitted: Use default connection settings
    • 0, 1, 2, etc.: Use the corresponding saved connection by index

  3. Backward Compatibility: Old configuration files without saved connections continue to work exactly as before.

General Controls

  • Tab - Switch between Tree, Query, and Record views
  • 1/2/3 - Jump directly to Start/Tree/Query/Record view
  • Ctrl+C or q - Exit application
  • ? - Toggle help modal (context-sensitive)
  • Ctrl+R - Refresh/reconnect to server

Start/Configuration View

  • ↑/↓ or j/k - Navigate through configuration fields
  • Enter - Edit field value or execute action
  • ←/→ or h/l - Navigate between saved connections (when in connection list)
  • Escape - Cancel editing or dialog

Connection Management

  • Add New Connection - Save current settings as a new named connection
  • Delete Connection - Remove the selected saved connection
  • Save Current as New - Create a new connection from current configuration
  • Navigate between saved connections and press Enter to switch to that connection

Tree View

  • ↑/↓ or j/k - Navigate up/down in tree
  • Page Up/Down - Navigate by page
  • Enter or → - Expand folder or view record
  • ← - Collapse folder or go up one level
  • / - Focus search/filter input
  • Escape - Clear search, return to tree navigation
  • Home/End - Jump to beginning/end of current level

Record View

  • ↑/↓ or j/k - Navigate through attributes
  • Page Up/Down - Navigate by page
  • Enter - Copy selected attribute value to clipboard
  • Escape or ← - Return to previous view
  • / - Focus search/filter for attributes

Query View

  • / or Escape - Focus query input
  • Ctrl+Enter or Ctrl+J - Execute query
  • Ctrl+F - Format query with proper indentation
  • Escape - Clear query
  • Ctrl+V - Paste from clipboard
  • ↑/↓ - Navigate results (when not in input mode)
  • Page Up/Down - Navigate by page (automatically loads more results)
  • Enter - View selected record

Note: The Query View uses automatic pagination to efficiently handle large result sets. When you scroll near the end of loaded results, the next page is automatically fetched from the LDAP server.

Query Formatting

The Ctrl+F key combination formats complex LDAP queries with proper indentation for better readability:

# Before formatting:
(&(objectClass=person)(|(cn=john*)(sn=smith*))(department=engineering))

# After formatting (Ctrl+F):
(&
  (objectClass=person)
  (|
    (cn=john*)
    (sn=smith*)
  )
  (department=engineering)
)
Installation
Next: Changelog