🚀 Quick Start

⚠️ Important Note: When using this tool, please ensure compliance with data security regulations and company policies. Access databases only with proper authorization and apply appropriate security measures to the generated documents.

Prerequisites

• Go 1.24+ or higher (required only for source code compilation)
• Supported target database (MySQL, PostgreSQL, Oracle, or SQLite)
• Database connection permissions (recommended for use in test environments)

Installation Methods

Option 1: Download Pre-compiled Binary (Recommended)

Download the latest pre-compiled version for your operating system from the Releases page:

• Windows: GenDict_Windows_x86_64.zip
• Linux: GenDict_Linux_x86_64.tar.gz
• macOS: GenDict_macOS_x86_64.tar.gz

After downloading, extract and use it directly without additional dependencies.

Option 2: Compile and Install from Source

# Clone the project code

git clone https://github.com/ourcolour/GenDict.git
cd GenDict

# Compile and install
go mod download
go build -o gen-dict main.go

# Move the executable to a directory included in the PATH environment variable, e.g.
sudo mv gen-dict /usr/local/bin/

Basic Usage

1. Start the application：

gen-dict

2. Configure connection: Enter the database connection information in the GUI interface

   • Host address, port number
   • Database name
   • Username and password
   • Database type (auto-detected)

3. Set output:

   • Select output format (Excel/Markdown)
   • Specify the save path

4. Generate document: Click the "Generate" button, wait for completion, and then check the output file

📋 Supported Databases

The current tool supports the following database types.

Prev：Home
Next：Contributing