Skip to content

Dev #48

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
OGR-67 merged 2 commits into from
Mar 22, 2026
Merged

Dev #48

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4b6061b
Add badges and improve formatting in README.md
OGR-67 Mar 22, 2026
62110a3
Merge pull request #47 from OGR-67/45-docs-add-readme-badges
OGR-67 Mar 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 20 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,21 @@
# AL2DBML

![Build](https://github.com/OGR-67/AL2DBML/actions/workflows/release.yml/badge.svg)
![Version](https://img.shields.io/github/v/release/OGR-67/AL2DBML)
![License](https://img.shields.io/github/license/OGR-67/AL2DBML)
![.NET](https://img.shields.io/badge/.NET-10.0-purple)

Generates a DBML database schema from a Business Central AL project by parsing table and field definitions.

## Prerequisites

No runtime required — AL2DBML is distributed as a self-contained binary.

| Platform | Supported |
|---|---|
| Windows (x64) | ✓ |
| macOS (Apple Silicon) | ✓ |
| Linux (x64) | ✓ |
| Platform | Supported |
| --------------------- | --------- |
| Windows (x64) | ✓ |
| macOS (Apple Silicon) | ✓ |
| Linux (x64) | ✓ |

## Installation

Expand Down Expand Up @@ -66,11 +71,11 @@ Parses AL files and generates a `.dbml` schema file.
al2dbml generate [-i <input>] [-o <output>] [-n <name>]
```

| Option | Description | Default |
|---|---|---|
| `-i`, `--input` | Path to an AL project folder, `.al` file, or `.code-workspace` file | Value from `config.local.json`, then `.` |
| `-o`, `--output` | Output directory | Value from `config.json`, then `.` |
| `-n`, `--name` | Output file name (without extension) | Value from `config.json`, then `schema` |
| Option | Description | Default |
| ---------------- | ------------------------------------------------------------------- | ---------------------------------------- |
| `-i`, `--input` | Path to an AL project folder, `.al` file, or `.code-workspace` file | Value from `config.local.json`, then `.` |
| `-o`, `--output` | Output directory | Value from `config.json`, then `.` |
| `-n`, `--name` | Output file name (without extension) | Value from `config.json`, then `schema` |

### `init`

Expand All @@ -86,12 +91,13 @@ Re-running `init` on an existing config pre-fills the prompts with current value

`init` creates two files in `.al2dbml/`:

| File | Versioned | Content |
|---|---|---|
| `config.json` | Yes | Output path and file name — shared across contributors |
| File | Versioned | Content |
| ------------------- | --------------- | -------------------------------------------------------- |
| `config.json` | Yes | Output path and file name — shared across contributors |
| `config.local.json` | No (gitignored) | Input path — contributor-specific, useful for workspaces |

`config.json` example:

```json
{
"Output": {
Expand All @@ -102,6 +108,7 @@ Re-running `init` on an existing config pre-fills the prompts with current value
```

`config.local.json` example:

```json
{
"Input": {
Expand Down
Loading