Schemacrawler logo

SchemaCrawler

Free database schema discovery and comprehension tool

SchemaCrawler Downloads

The Central Repository Main distribution Docker Pulls

Distributions and Downloads

SchemaCrawler is distributed in a variety of ways, to support various use cases.

If you would like to use SchemaCrawler without installing it, you can explore the SchemaCrawler command-line with a live online tutorial. The tutorial works from within any browser with no software or plugins needed.

If you need to use SchemaCrawler locally, you have a number of options. You can download SchemaCrawler releases with tutorials from GitHub. You can install the SchemaCrawler Interactive Shell using platform-specific installers downloaded from schemacrawler/SchemaCrawler-Installers. For Windows, SchemaCrawler is also available via the Scoop command-line installer, Chocolatey package manager, SDKMan, as well as via Microsoft Windows Package Manager, winget.

If you want to use SchemaCrawler as a library, and in your build, all jars are in the Central Repository. They can be used as dependencies in Gradle or Apache Maven projects, or with any other build system that supports the Central Repository. SchemaCrawler reports can be incorporated into Apache Maven builds with the SchemaCrawler Report Maven Plugin and into the GitHub Actions workflow with the SchemaCrawler Action or in GitLab pipelines. If you would like to extend SchemaCrawler with plugins for a certain database, create new database lints, or create a new command, use the starter projects to create new SchemaCrawler plugins on GitHub.

Pre-packaged SchemaCrawler Docker images are available on Docker Hub.

Additional SchemaCrawler database plugins are available from the schemacrawler/SchemaCrawler-Database-Plugins project.

Installation on Windows

Scoop

Scoop

You can install SchemaCrawler on Windows using the Scoop command-line installer. Follow these steps:

  1. Install a Java runtime
  2. Install the Scoop command-line installer
  3. Run
    scoop install schemacrawler
    from a PowerShell command-prompt
  4. Run SchemaCrawler with schemacrawler

Chocolatey

Chocolatey

You can install SchemaCrawler on Windows using Chocolatey. Follow these steps:

  1. Install a Java runtime
  2. Install Chocolatey
  3. Run
    choco install schemacrawler
    from a PowerShell command-prompt with administrative privileges
  4. Run SchemaCrawler with schemacrawler

The Chocolatey SchemaCrawler package is maintained by Adrien Sales.

Cross-platform Installation

SDKMan

You can install SchemaCrawler on supported platforms using SDKMan. Follow these steps:

  1. Install SDKMan
  2. Install a Java runtime (or use SDKMan to install it)
  3. Run
    sdk install schemacrawler
    from a command-prompt
  4. Run SchemaCrawler with schemacrawler.bat on Windows, or schemacrawler.sh on other platforms

Running Examples Locally

You can download example code explaining how to use SchemaCrawler from the releases page. Download a file called “schemacrawler-16.21.2-distribution.zip”. You should have previously installed the Java SDK on your system. Unzip the file, and read the README files in each folder to follow through with the examples. The examples show how to use the SchemaCrawler command-line, use the API, and extend SchemaCrawler functionality programmatically.