⭐ Star it ⤴️ if you love it!

SchemaCrawler is a free database schema discovery and comprehension tool. SchemaCrawler has a good mix of useful features for data governance. You can search for database schema objects using regular expressions, and output the schema and data in a readable text format.

This is a bare project that allows you to run SchemaCrawler from the terminal.

1. GitHub Account - Sign up at github.com
2. GitHub Codespaces - Follow the GitHub Codespaces quickstart
3. Click the green "Code" button on this repository and select "Create codespace on main"

1. Docker - Install from docker.com
2. Docker Compose - Included with Docker Desktop, or install separately from docs.docker.com
3. Visual Studio Code - Download from code.visualstudio.com
4. Dev Containers Extension - Install the Dev Containers extension for VS Code
5. Read Developing inside a Container documentation

• Use MCP servers in VS Code
• Dev Containers tutorial

1. Fork or clone this repository
2. Click the green "Code" button and select "Create codespace on main"
3. Wait for the codespace to build (first time may take a few minutes)
4. The SchemaCrawler environment will be automatically set up

1. Clone this project
2. Open the project folder in Visual Studio Code
3. When prompted, click "Reopen in Container" (or press F1 and select "Dev Containers: Reopen in Container")
4. Wait for the container to build and start

Whichever way you started Visual Studio Code, start a new "bash" terminal. This will take you into the SchemaCrawler shell. In the shell, run schemacrawler --version to verify that SchemaCrawler is available.

Continue to the getting started documentation.