litexplore 0.0.3

A small example package

litexplore

The current options to explore remote SQLite databases require running a service on the remote and make it listen on some port. Another option is SSH'ing to the remote instance and use the SQLite CLI to explore the database. Litexplore is a Python web app that lets you explore remote SQLite databases over SSH connections without having to copy the full DB or manually use the CLI.

It works by sending commands over an SSH connection. The connection is multiplexed and it's reused to send commands. This reduces the overhead of openning a new SSH connection to send each command.

NOTE: litexplore is still in an early beta state. It works and it's usable, but there may be signficant changes happening.

Requirements

• python 3.7 or higher
• pydantic
• fastapi
• uvicorn
• Jinja2
• python-multipart

Installation

1. Create a virtual env

python3 -m venv .venv

2. Activate the venv and install the dependencies

source .venv/bin/activate
python3 -m pip install litexplore

3. Run the program

litexplore

4. Open your browser at http://127.0.0.1:8000

Note: even though the server uses 0.0.0.0 as the default host, open the browser at 127.0.0.1. Otherwise, cookies won't work and they're used to store the user config.

Run litexplore --help to see other available options.

Using pipx

1. Install litexplore

pipx install litexplore

2. Run it:

litexplore

Usage

The main page is a form with 3 inputs.

• The first input us the SSH host name as defined in your ~/.sshconfig`
• The second input is the path to an SQLite database in the remote host
• The third (optional) input is a path to an SQLite CLI. Some pre-installed sqlite3 CLIs have not been compiled with support for the -json flag, which litexplore uses.

How it works

See this blog post

Roadmap

See roadmap issues