wdevs/relspecgo
5
1
Fork 0
Code Issues 3 Pull Requests Actions Packages Releases 84 Wiki Activity

docs: README covers mysql, update command and Windows installer

Browse Source
This commit is contained in:
warkanum
2026-10-03 23:22:03 +02:00
parent 9da69f4234
commit 9447d18323
1 changed files with 19 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+19 -2
View File
@@ -16,12 +16,16 @@
go install -v git.warky.dev/wdevs/relspecgo/cmd/relspec@latest
```
Windows: download `relspec-setup-windows-amd64.exe` from the
[latest release](https://git.warky.dev/wdevs/relspecgo/releases/latest)
(installs to Program Files and adds `relspec` to `PATH`). See [windows/README.md](windows/README.md).
## Supported Formats
| Direction | Formats |
|-----------|---------|
| **Readers** | `bun` `dbml` `dctx` `drawdb` `drizzle` `gorm` `graphql` `json` `mssql` `pgsql` `prisma` `sqldir` `sqlite` `typeorm` `yaml` |
| **Writers** | `bun` `dbml` `dctx` `drawdb` `drizzle` `gorm` `graphql` `json` `mssql` `pgsql` `prisma` `sqlexec` `sqlite` `template` `typeorm` `yaml` |
| **Readers** | `bun` `dbml` `dctx` `drawdb` `drizzle` `gorm` `graphql` `json` `mssql` `mysql` `pgsql` `prisma` `sqldir` `sqlite` `typeorm` `yaml` |
| **Writers** | `bun` `dbml` `dctx` `drawdb` `drizzle` `gorm` `graphql` `json` `mssql` `mysql` `pgsql` `prisma` `sqlexec` `sqlite` `template` `typeorm` `yaml` |
See [docs/FORMAT_EXAMPLES.md](docs/FORMAT_EXAMPLES.md) for usage examples covering every format.
@@ -194,6 +198,16 @@ relspec edit --from pgsql --from-conn "postgres://user:pass@localhost/mydb" \
<img src="./assets/image/screenshots/edit_column.jpg">
</p>
### `update` — Check for a newer release
```bash
relspec update # check, prompt, then download + run installer (Windows)
relspec update --check # report only
relspec update --yes # skip the prompt
```
Non-Windows platforms print the release URL. `dev` and commit-hash builds are never reported as outdated.
## Development
**Prerequisites:** Go 1.24.0+
@@ -204,6 +218,7 @@ make test # race detection + coverage
make lint # requires golangci-lint
make coverage # → coverage.html
make install # → $GOPATH/bin
make installer-windows # → build/relspec-setup-windows-amd64.exe (needs makensis)
```
## Project Structure
@@ -218,6 +233,8 @@ pkg/merge/ Schema merging
pkg/models/ Internal data models
pkg/transform/ Transformation logic
pkg/pgsql/ PostgreSQL utilities
pkg/updatecheck/ Latest-release lookup and version comparison
windows/ NSIS installer script
pkg/sqltypes/ Nullable SQL types for generated/hand-written models (see below)
```