Daedalus CLI

中文文档 | Chinese Documentation

Craft Your Path in the Data Labyrinth.

Daedalus CLI is a Rust-based command-line interface tool for PostgreSQL and Redis database management and exploration. It provides an intuitive terminal user interface (TUI) that allows users to connect to PostgreSQL and Redis databases, browse tables and keys, and view data with pagination support.

Cross-Platform Support

Daedalus CLI is now fully cross-platform compatible, supporting Windows, macOS, and Linux systems. Key improvements include:

• Cross-platform home directory support: Uses the dirs crate to properly locate the user's home directory on all platforms
• Fixed Windows config directory issue: Ensures the configuration directory (.daedalus-cli) is created in the user's home directory rather than the current working directory on Windows
• Improved cross-platform compatibility: Replaced tempdir with tempfile for better temporary file handling across platforms

Features

• Multi-Database Connection Management: Add, list, and remove saved PostgreSQL and Redis connections with encrypted storage of connection information in ~/.daedalus-cli/config.json
• Terminal User Interface: Intuitive TUI for browsing PostgreSQL database tables and Redis keys, using arrow keys to navigate between items in the current view
• PostgreSQL Data Exploration: Browse database tables with column headers, view table data with row highlighting
• Redis Data Exploration: Browse Redis keys with metadata, view key values with type-specific display (string, list, set, hash, sorted set)
• Pagination Support: Navigate large datasets using PageUp/PageDown keys
• Field-Level Navigation: Navigate between individual fields within a selected record using left/right arrow keys
• Detailed Field View: View complete field values by pressing Enter on a selected field, with support for scrolling through long text using up/down arrow keys
• Custom SQL Queries: Execute custom SQL queries directly from the TUI with result pagination
• Secure Storage: AES-256-GCM encryption for storing sensitive connection password information
• Cross-Platform Compatibility: Full support for Windows, macOS, and Linux systems with consistent behavior

Installation

Install Daedalus CLI from crates.io:

cargo install daedalus-cli

Or build from source:

git clone https://github.com/Zephyruston/daedalus-cli.git
cd daedalus-cli
cargo install --path .

Usage

Adding a Database Connection

Add a new PostgreSQL connection with a custom name:

daedalus-cli add-conn postgresql://username:password@host:port/database --name mydb

Add a new Redis connection with a custom name:

daedalus-cli add-conn redis://username:password@host:port/database --name myredis

Or let the system generate a name based on host and database:

daedalus-cli add-conn postgresql://username:password@host:port/database
daedalus-cli add-conn redis://username:password@host:port/database

Listing Saved Connections

List all saved database connections:

daedalus-cli list-conns

Removing a Connection

Remove a saved connection:

daedalus-cli remove-conn mydb

Connecting to a Database

Connect to a saved database using the TUI:

daedalus-cli connect mydb

Testing a Connection

Test a connection without opening the TUI:

daedalus-cli ping mydb

Generating Shell Completions

Generate command-line completion scripts for bash, zsh, and fish:

# Generate completion script for bash
daedalus-cli completions bash

# Generate completion script for zsh
daedalus-cli completions zsh

# Generate completion script for fish
daedalus-cli completions fish

To make completions effective in the current session, you need to execute one of the following operations based on your shell type:

For bash:

# Generate and save the completion script
daedalus-cli completions bash > ~/.bash_completion.d/daedalus-cli
# Source the file in your .bashrc
echo "source ~/.bash_completion.d/daedalus-cli" >> ~/.bashrc
# Reload configuration
source ~/.bashrc

For zsh:

# Generate completion script to standard location
daedalus-cli completions zsh > /usr/local/share/zsh/site-functions/_daedalus-cli
# Or for user-specific installation
mkdir -p ~/.zsh/completion
daedalus-cli completions zsh > ~/.zsh/completion/_daedalus-cli
echo "fpath+=~/.zsh/completion" >> ~/.zshrc
# Reload configuration
source ~/.zshrc

For fish:

# Generate completion script to fish's completions directory
mkdir -p ~/.config/fish/completions
daedalus-cli completions fish > ~/.config/fish/completions/daedalus-cli.fish
# Restart fish or reload configuration

TUI Navigation

After connecting to a database, the TUI provides the following navigation controls:

• Arrow keys (↑/↓): Navigate between records in the current view
• Left/Right arrow keys (←/→): When a record is selected, navigate between individual fields within that record
• Enter: Select highlighted record or view detailed field value when a field is selected
• PageUp/PageDown: Navigate in large datasets
• 's': Enter custom SQL query mode or return to query input
• 't': Return to table list
• 'c': Return to connection selection
• 'q' or Esc: Exit the application

Field Detail View Navigation

When viewing detailed field values:

• Up/Down arrow keys (↑/↓): Scroll through long text content in the field detail view
• Esc: Return to the table view
• 'q': Exit the application

Custom SQL Queries

Daedalus CLI now supports executing custom SQL queries directly from the TUI:

• Enter Query Mode: Press 's' from the table list view to enter custom query input mode
• Execute Query: Type your SQL query and press Enter to execute it
• View Results: Query results are displayed in a paginated table format
• Navigate Results: Use arrow keys to navigate through rows, PageUp/PageDown to change pages
• Query Input: The query input area supports text editing with cursor movement (left/right, home/end)
• Return to Query Input: Press 's' while viewing results to go back to the query input screen

Security

Daedalus CLI implements security measures to protect your database credentials:

• Connection passwords are encrypted using AES-256-GCM before being stored to the config file
• Randomly generated encryption key is stored in ~/.daedalus-cli/key.bin
• All connections are established using the secure tokio-postgres library

Development

Prerequisites

• Rust edition 2024
• PostgreSQL server connection (or use Docker container provided)

Testing

# Run tests
cargo test

# Check for compilation errors
cargo check

# Run linter
cargo clippy

Docker Support

The project includes a docker-compose.yml file for setting up PostgreSQL and Redis containers with sample data for testing:

# Start PostgreSQL and Redis containers with sample data
docker-compose up -d

# Stop containers
docker-compose down

Using the Docker Test Databases

1. Start the test databases:

   docker-compose up -d
   

2. Wait for database initialization:

   • After the containers start, the databases need some time to initialize and be running
   • You can use docker-compose logs -f to view startup progress
   • By default, PostgreSQL will run on port 5432 and Redis on port 6379

3. Connect to the test PostgreSQL database:

   daedalus-cli add-conn postgresql://test:123456@localhost:5432/test_db --name test_postgres
   

4. Connect to the test Redis database:

   daedalus-cli add-conn redis://default:@localhost:6379/0 --name test_redis
   

5. Test the connections:

   daedalus-cli ping test_postgres
   daedalus-cli ping test_redis
   

6. Browse data:

   daedalus-cli connect test_postgres  # Browse PostgreSQL data
   daedalus-cli connect test_redis     # Browse Redis keys
   

Test Database Structure

The Docker test database includes the following sample databases for demonstration purposes:

PostgreSQL:

• users: Stores user information (id, username, email, created_at)
• projects: Stores project information (id, name, description, owner_id)
• tasks: Stores task information (id, title, description, project_id, assigned_to, status, priority)
• api_keys: Stores API keys (id, key_value, user_id, name, permissions)

These tables contain sample data that allows you to test Daedalus CLI functionality in a real PostgreSQL environment.

Redis:

• The Redis instance starts empty but can be populated with various data types (strings, lists, sets, hashes, sorted sets) for testing the Redis browsing functionality.

Stopping the Test Databases

After you are done, you can stop all database containers:

docker-compose down

This will stop all running containers but preserve the data volumes. If you need to remove the data volumes (clearing all data), use:

docker-compose down -v

Configuration

Connection information is stored in ~/.daedalus-cli/config.json. This includes:

• Host, port, database name, username
• Encrypted password data
• Connection name for identification

The encryption key is stored in ~/.daedalus-cli/key.bin and should be kept secure.

License

MIT License - see the LICENSE file for details.