Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/ericschmar/moribito


https://github.com/ericschmar/moribito

Last synced: 13 days ago
JSON representation

Awesome Lists containing this project

README 

          
# ๆฃฎไบบ - Mori-bito (forest-person)





  Mori-bito - Forest Person




A terminal-based LDAP server explorer built with Go and BubbleTea, providing an interactive interface for browsing LDAP directory trees, viewing records, and executing custom queries.



## Features



-   ๐ŸŒฒ **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



## Screenshots



### Main Interface



![Start Screen](screenshots/start.png)

_Initial startup screen with connection options_



### Adding Connections



![Add Interface](screenshots/add.png)

_Interface for adding new LDAP Connections



### Interactive Tree Navigation



![Tree View](screenshots/tree.png)

_Browse LDAP directory structure with keyboard/mouse navigation_



### Record Viewer



![Record View](screenshots/record.png)

_View detailed LDAP entry attributes with clipboard integration_



### Custom Query Interface



![Query View](screenshots/query.png)

_Execute custom LDAP queries with real-time results and formatting_



## Installation



### Homebrew (Recommended for macOS/Linux)



```bash

brew install moribito

```



### Arch Linux (AUR)



#### Last Release

```bash

yay -S moribito

```



#### Development Version

```bash

yay -S moribito-git

```

PKGBUILDS are available here:

 - https://aur.archlinux.org/packages/moribito

 - https://aur.archlinux.org/packages/moribito-git



### From GitHub Releases



Download the latest pre-built binary from [GitHub Releases](https://github.com/ericschmar/moribito/releases):



#### Option 1: Quick Install Scripts (Recommended)



**Linux/Unix:**



```bash

curl -sSL https://raw.githubusercontent.com/ericschmar/moribito/main/scripts/install.sh | bash

```



**macOS:**



```bash

curl -sSL https://raw.githubusercontent.com/ericschmar/moribito/main/scripts/install-macos.sh | bash

```



**Windows (PowerShell):**



```powershell

irm https://raw.githubusercontent.com/ericschmar/moribito/main/scripts/install.ps1 | iex

```



The install scripts will:



-   Download the appropriate binary for your platform

-   Install it to the system PATH

-   Create OS-specific configuration directories

-   Generate sample configuration files



#### Option 2: Manual Download



```bash

# Linux x86_64

curl -L https://github.com/ericschmar/moribito/releases/latest/download/moribito-linux-amd64 -o moribito

chmod +x moribito

sudo mv moribito /usr/local/bin/



# Linux ARM64

curl -L https://github.com/ericschmar/moribito/releases/latest/download/moribito-linux-arm64 -o moribito

chmod +x moribito

sudo mv moribito /usr/local/bin/



# macOS Intel

curl -L https://github.com/ericschmar/moribito/releases/latest/download/moribito-darwin-amd64 -o moribito

chmod +x moribito

sudo mv moribito /usr/local/bin/



# macOS Apple Silicon

curl -L https://github.com/ericschmar/moribito/releases/latest/download/moribito-darwin-arm64 -o moribito

chmod +x moribito

sudo mv moribito /usr/local/bin/

```



For Windows, download `moribito-windows-amd64.exe` from the releases page.



> **Note**: Homebrew is also available for Windows via WSL (Windows Subsystem for Linux). If you have WSL installed, you can use the Homebrew installation method above.



### From Source



```bash

git clone https://github.com/ericschmar/moribito

cd moribito

go build -o moribito cmd/moribito/main.go

```



## Usage



### Command Line Options



```bash

# Connect with command line options

moribito -host ldap.example.com -base-dn "dc=example,dc=com" -user "cn=admin,dc=example,dc=com"



# Enable automatic update checking

moribito -check-updates -host ldap.example.com -base-dn "dc=example,dc=com"



# Use a configuration file

moribito -config /path/to/config.yaml



# Get help

moribito -help

```



### Configuration File



Moribito will automatically look for configuration files in OS-specific locations:



**Linux/Unix:**



-   `~/.config/moribito/config.yaml` (XDG config directory)

-   `~/.moribito/config.yaml` (user directory)

-   `~/.moribito.yaml` (user home file)



**macOS:**



-   `~/.moribito/config.yaml` (user directory)

-   `~/Library/Application Support/moribito/config.yaml` (macOS standard)

-   `~/.moribito.yaml` (user home file)



**Windows:**



-   `%APPDATA%\moribito\config.yaml` (Windows standard)

-   `%USERPROFILE%\.moribito.yaml` (user home file)



**All platforms also check:**



-   `./config.yaml` (current directory)



#### Creating Configuration



Use the built-in command to create a configuration file:



```bash

moribito --create-config

```



Or manually create a configuration file:



```yaml

ldap:

    host: "ldap.example.com"

    port: 389

    base_dn: "dc=example,dc=com"

    use_ssl: false

    use_tls: false

    bind_user: "cn=admin,dc=example,dc=com"

    bind_pass: "your-password"

pagination:

    page_size: 50 # Number of entries per page

retry:

    enabled: true # Connection retries (default: true)

    max_attempts: 3 # Retry attempts (default: 3)

    initial_delay_ms: 500 # Initial delay (default: 500)

    max_delay_ms: 5000 # Max delay cap (default: 5000)

```



## Navigation



### General Controls



-   **Tab** - Switch between views (Tree โ†’ Record โ†’ Query โ†’ Tree)

-   **1/2/3** - Jump directly to Tree/Record/Query view

-   **q** - Quit application



### Tree View



-   **โ†‘/โ†“** or **k/j** - Navigate up/down

-   **Page Up/Down** - Navigate by page

-   **Home/End** - Jump to top/bottom

-   **โ†’** or **l** - Expand node (load children)

-   **โ†** or **h** - Collapse node

-   **Enter** - View record details



### Record View



-   **โ†‘/โ†“** or **k/j** - Scroll up/down

-   **Page Up/Down** - Scroll by page

-   **Home/End** - Jump to top/bottom

-   **c** - Copy current attribute value to clipboard



### 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)

)

```



## Authentication Methods



The tool supports various LDAP authentication methods:



### Simple Bind



```yaml

bind_user: "cn=admin,dc=example,dc=com"

bind_pass: "password"

```



### OU-based Authentication



```yaml

bind_user: "uid=john,ou=users,dc=example,dc=com"

bind_pass: "password"

```



### Active Directory Style



```yaml

bind_user: "john@example.com"

bind_pass: "password"

```



### Anonymous Bind



```yaml

# Leave bind_user and bind_pass empty or omit them

```



## Security Options



### SSL/LDAPS (Port 636)



```yaml

ldap:

    host: "ldaps.example.com"

    port: 636

    use_ssl: true

```



### StartTLS (Port 389)



```yaml

ldap:

    host: "ldap.example.com"

    port: 389

    use_tls: true

```



## Query Examples



In the Query view, you can execute custom LDAP filters:



-   `(objectClass=*)` - All objects

-   `(objectClass=person)` - All person objects

-   `(cn=john*)` - Objects with cn starting with "john"

-   `(&(objectClass=person)(mail=*@example.com))` - People with example.com emails

-   `(|(cn=admin)(uid=admin))` - Objects with cn=admin OR uid=admin



### Complex Query Formatting



For complex nested queries, use **Ctrl+F** to automatically format them for better readability:



**Simple queries remain unchanged:**



```

(objectClass=person)

```



**Complex queries are formatted with proper indentation:**



```

# Original

(&(objectClass=person)(|(cn=john*)(sn=smith*))(department=engineering))



# After Ctrl+F

(&

  (objectClass=person)

  (|

    (cn=john*)

    (sn=smith*)

  )

  (department=engineering)

)

```



## Performance & Pagination



LDAP CLI uses intelligent pagination to provide optimal performance when working with large directories:



### Automatic Pagination



-   **Default Page Size**: 50 entries per page

-   **Configurable**: Adjust via config file or `--page-size` flag

-   **On-Demand Loading**: Next pages load automatically as you scroll

-   **Memory Efficient**: Only loaded entries are kept in memory



### Configuration Examples



```bash

# Command line override

moribito --page-size 100 --host ldap.example.com



# Configuration file

pagination:

  page_size: 25  # Smaller pages for slower networks

```



### Performance Tips



-   **Smaller page sizes** (10-25) for slower networks or limited LDAP servers

-   **Larger page sizes** (100-200) for fast networks and powerful LDAP servers

-   **Use specific queries** to reduce result sets instead of browsing all entries



## Connection Reliability & Retries



LDAP CLI includes automatic retry functionality to handle connection failures gracefully:



### Automatic Retries



-   **Default**: Enabled with 3 retry attempts

-   **Exponential Backoff**: Delay doubles between attempts (500ms โ†’ 1s โ†’ 2s โ†’ ...)

-   **Connection Recovery**: Automatically re-establishes broken connections

-   **Smart Detection**: Only retries connection-related errors, not authentication failures



### Configuration Examples



```bash

# Default retry settings (automatically applied)

# No configuration needed - retries work out of the box

```



```yaml

# Custom retry configuration

retry:

    enabled: true

    max_attempts: 5 # Maximum retry attempts (default: 3)

    initial_delay_ms: 1000 # Initial delay in milliseconds (default: 500)

    max_delay_ms: 10000 # Maximum delay cap (default: 5000)

```



```yaml

# Disable retries if needed

retry:

    enabled: false

```



### Retryable Conditions



The system automatically retries for:



-   **Network timeouts** and connection drops

-   **Connection refused** errors

-   **Server unavailable** responses

-   **Connection reset** by peer

-   **LDAP server down** errors



Authentication errors, invalid queries, and permission issues are **not** retried.



## Development



### Building



```bash

# Build for current platform

make build



# Build for all platforms

make build-all



# Clean build artifacts

make clean

```



### Code Quality



```bash

# Format code

make fmt



# Run linter

make lint



# Run tests

make test



# Run all CI checks (format, lint, test, build)

make ci

```



### Testing



```bash

go test ./...

```



### Continuous Integration



This project uses GitHub Actions for CI/CD:



-   **CI Workflow**: Runs on every push and pull request to `main` and `develop` branches



    -   Code formatting verification

    -   Linting (with warnings)

    -   Testing

    -   Building for current platform

    -   Multi-platform build artifacts (on main branch pushes)



-   **Release Workflow**: Triggered by version tags (e.g., `v1.0.0`)

    -   Runs full CI checks

    -   Builds for all platforms (Linux amd64/arm64, macOS amd64/arm64, Windows amd64)

    -   Creates GitHub releases with binaries and checksums

    -   Generates installation instructions



### Dependencies



-   [BubbleTea](https://github.com/charmbracelet/bubbletea) - TUI framework

-   [Lipgloss](https://github.com/charmbracelet/lipgloss) - Styling

-   [go-ldap](https://github.com/go-ldap/ldap) - LDAP client

-   [golang.org/x/term](https://golang.org/x/term) - Terminal utilities



### Homebrew Distribution



This project includes full Homebrew support for easy installation on macOS and Linux. See the [homebrew/](homebrew/) directory for:



-   Ready-to-use Homebrew formula

-   Formula generation and maintenance scripts

-   Documentation for creating custom taps

-   Instructions for submitting to homebrew-core



### Versioning



This project follows [Semantic Versioning](https://semver.org/). See [docs/versioning.md](docs/versioning.md) for details on the release process.



## Documentation



Comprehensive documentation is available using DocPress. To build and view the documentation:



```bash

# Build static documentation website

make docs



# Serve documentation locally with live reload

make docs-serve

```



The documentation covers:



-   Installation and setup

-   Usage guide with examples

-   Interface navigation

-   Development setup

-   Contributing guidelines

-   API reference and advanced features



Visit the generated documentation site for the complete guide.



## Contributing



1. Fork the repository

2. Create your feature branch (`git checkout -b feature/amazing-feature`)

3. Commit your changes (`git commit -m 'Add some amazing feature'`)

4. Push to the branch (`git push origin feature/amazing-feature`)

5. Open a Pull Request



## License



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