https://github.com/PeepDB-dev/peepdb Skip to content Navigation Menu Toggle navigation Sign in * Product + Actions Automate any workflow + Packages Host and manage packages + Security Find and fix vulnerabilities + Codespaces Instant dev environments + GitHub Copilot Write better code with AI + Code review Manage code changes + Issues Plan and track work + Discussions Collaborate outside of code Explore + All features + Documentation + GitHub Skills + Blog * Solutions By size + Enterprise + Teams + Startups By industry + Healthcare + Financial services + Manufacturing By use case + CI/CD & Automation + DevOps + DevSecOps * Resources Topics + AI + DevOps + Security + Software Development + View all Explore + Learning Pathways + White papers, Ebooks, Webinars + Customer Stories + Partners * Open Source + GitHub Sponsors Fund open source developers + The ReadME Project GitHub community articles Repositories + Topics + Trending + Collections * Enterprise + Enterprise platform AI-powered developer platform Available add-ons + Advanced Security Enterprise-grade security features + GitHub Copilot Enterprise-grade AI features + Premium Support Enterprise-grade 24/7 support * Pricing Search or jump to... Search code, repositories, users, issues, pull requests... Search [ ] Clear Search syntax tips Provide feedback We read every piece of feedback, and take your input very seriously. [ ] [ ] Include my email address so I can be contacted Cancel Submit feedback Saved searches Use saved searches to filter your results more quickly Name [ ] Query [ ] To see all available qualifiers, see our documentation. Cancel Create saved search Sign in Sign up Reseting focus You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert {{ message }} PeepDB-dev / peepdb Public * Notifications You must be signed in to change notification settings * Fork 9 * Star 168 CLI tool and python library to inspect databases fast. peepdb.dev/ License GPL-3.0 license 168 stars 9 forks Branches Tags Activity Star Notifications You must be signed in to change notification settings * Code * Issues 10 * Pull requests 0 * Actions * Projects 0 * Security * Insights Additional navigation options * Code * Issues * Pull requests * Actions * Projects * Security * Insights PeepDB-dev/peepdb This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository. main BranchesTags Go to file Code Folders and files Name Name Last commit Last commit message date Latest commit History 57 Commits .github/workflows .github/ workflows docs docs images images peepdb peepdb .gitignore .gitignore CONTRIBUTING.md CONTRIBUTING.md LICENSE LICENSE MANIFEST.in MANIFEST.in README.md README.md project.toml project.toml requirements.txt requirements.txt setup.py setup.py View all files Repository files navigation * README * GPL-3.0 license peepDB peepDB is an open-source command-line tool and Python library designed for developers and database administrators who need a fast and efficient way to inspect their database tables without writing SQL queries. With support for MySQL, PostgreSQL, and MariaDB, peepDB is lightweight, secure, and incredibly easy to use. Features * Multi-Database Support: Works with MySQL, PostgreSQL, and MariaDB. * Quick Data Inspection: View all tables or a specific table with a simple command. * User-Friendly CLI: Easy-to-use command-line interface powered by Click. * Secure Local Storage: Securely store database connection details with encryption on your local machine. * Lightweight: Minimal footprint, designed for speed. * Formatted Output: View data in a clean, formatted table or JSON format. * Pagination: Efficiently handle large datasets by viewing data in manageable chunks. peepDB in Action Here's a quick demonstration of peepDB: peepDB Demo [?] peepDB stills peepDB example 2 Note: The above image reflect the commands used in the official release (v0.1.3) Installation You can install peepDB directly from PyPI: pip install peepdb Requirements: * Python 3.6 or higher * pip (Python package installer) Note: If peepdb gives an error like "The term 'peepdb' is not recognized as the name of a cmdlet" remember to add the Python Scripts folder to your PATH in Windows. System Dependencies Before installing peepdb, ensure you have the following system dependencies: sudo apt-get update sudo apt-get install libmariadb3 libmariadb-dev Verify the installation by running: peepdb --version [?] Usage peepDB uses a command-based structure for easier and more intuitive use. Here are the main commands: 1. Save Your Database Connection Details peepdb save --db-type [mysql/postgres/mariadb] --host --user --database You'll be prompted securely for the password. 2. List Saved Connections peepdb list 3. View Tables View all tables: peepdb view View a specific table: peepdb view --table 4. Pagination Use pagination to handle large datasets: peepdb view --table --page --page-size 5. Choose Output Format Get output in JSON format: peepdb view --format json 6. Remove Saved Connections Remove a specific connection: peepdb remove Remove all connections: peepdb remove-all For more detailed usage information on any command, use the --help option: peepdb --help For Developers Please refer to our Contributing Guide for information on setting up the development environment, running tests, and contributing to peepDB. Security peepDB implements several security measures to protect your database connection details: 1. Local Storage: All connection details are stored locally on your machine, not on any remote servers. 2. Encryption: Connection details are encrypted before being stored, using the cryptography library. 3. Secure Password Input: Passwords are never shown in plain text and are input securely. However, please note that while we strive to implement best security practices, peepDB's security has not been verified by a third party. Users should exercise caution and follow general security best practices when using any tool that handles sensitive information. The encryption key is stored in your user directory (~/.peepdb/ key.key). Keep this key safe and do not share it. License Distributed under the GNU General Public License Version 3. See the LICENSE file for more details. Documentation For more detailed documentation, please visit our GitHub Pages. About CLI tool and python library to inspect databases fast. peepdb.dev/ Topics python cli open-source sql python3 database-management Resources Readme License GPL-3.0 license Activity Custom properties Stars 168 stars Watchers 3 watching Forks 9 forks Report repository Releases 3 v0.1.3 Latest Sep 15, 2024 + 2 releases Packages 0 No packages published Contributors 3 * * * Languages * Python 100.0% Footer (c) 2024 GitHub, Inc. Footer navigation * Terms * Privacy * Security * Status * Docs * Contact * Manage cookies * Do not share my personal information You can't perform that action at this time.