Installation
Download the app or the command line for Windows, macOS or Linux. No .NET install and no account needed.
On this page
Download The Sharp Factory App#
The Sharp Factory App runs on Windows, macOS and Linux. Download The Sharp Factory. The link takes you to the latest release on GitHub. Download the file for your operating system from the release assets:
Windows: TheSharpFactory-win-x64.zip (or TheSharpFactory-win-arm64.zip on ARM).
macOS: TheSharpFactory-osx-arm64.zip on Apple silicon, TheSharpFactory-osx-x64.zip on Intel.
Linux: TheSharpFactory-linux-x64.tar.gz.
The app is self-contained: you do not need to install .NET to run it.
From version 1.2.0.8, each release also has two small files next to the downloads: SHA256SUMS.txt, the SHA-256 of every download (one line per file), and SHA256SUMS.txt.sig, the signature of that file, made with The Sharp Factory's private key. You don't need them to install the app; see Check Your Download if you want to use them.
Unzip And Run#
-
Windows: create a folder where you would like to keep the application, unzip the download there and run TheSharpFactory.exe.
-
macOS: unzip the download and move TheSharpFactory.app to your Applications folder. The app is not signed yet, so macOS blocks it the first time: open it once, then go to System Settings > Privacy & Security and choose Open Anyway. On macOS 14 or earlier, right-click the app (or Control-click) and choose Open instead. After that it opens normally, and it also opens .edmj files.
-
Linux: extract the download to a folder of your choice and run TheSharpFactory.
The Command Line#
The app download also has the sharpfactory command line, from the same build (from version 1.2.0.8):
Windows: sharpfactory.exe, next to TheSharpFactory.exe.
macOS: TheSharpFactory.app/Contents/MacOS/sharpfactory.
Linux: sharpfactory, next to TheSharpFactory.
For machines without the app, such as build servers, each release also has the command line on its own (sharpfactory-cli-win-x64.zip, sharpfactory-cli-osx-arm64.tar.gz, sharpfactory-cli-linux-x64.tar.gz and so on).
It syncs or generates the code from a saved model file, and updates the model from its database, without opening the app, which is useful in scripts and build pipelines:
sharpfactory sync <model.edmj> <solution.sln|.slnx> [--preview]
sharpfactory generate <model.edmj> <output folder>
sharpfactory update <model.edmj> [--model <name>] [--check]
sharpfactory info <model.edmj>
sharpfactory --version (from version 1.2.0.8)
With --preview, sync writes nothing and prints how many projects, references and files it would add, change or delete.
update reads each model's objects again from its database, as the app's Update does when you keep every object, and saves the file;
with --check it saves nothing and exits with 1 when a model would change, so a build can stop when the model is behind the database.
info shows each model's connection and object counts.
From version 1.2.0.8 on, --version (or version) shows the version, for example sharpfactory 1.2.0.8, the same number as the app's About page and its release;
in a build pipeline it logs which version generated the code.
Check Your Download#
This is optional. To check that a download arrived whole, download SHA256SUMS.txt into the same folder and compare:
-
Windows (PowerShell): run the command below and compare the hash with the download's line in SHA256SUMS.txt.
Get-FileHash .\TheSharpFactory-win-x64.zip -
macOS: run the command below and compare the hash with the download's line in SHA256SUMS.txt.
shasum -a 256 TheSharpFactory-osx-arm64.zip -
Linux: in the folder with the downloads, run the command below. It prints
OKfor each download it checks.sha256sum -c SHA256SUMS.txt --ignore-missing
To check that The Sharp Factory signed SHA256SUMS.txt (needs openssl), also download SHA256SUMS.txt.sig and the public key, update-signing-key.pem (in the repository at App/SF.App/Packaging), and run:
openssl dgst -sha256 -verify update-signing-key.pem -signature SHA256SUMS.txt.sig SHA256SUMS.txt
It prints Verified OK.
This is not Windows or Apple code signing: the Windows SmartScreen warning and the macOS Open Anyway step stay the same.
Updates#
In 1.1.8.8 every paged read in the generated code (any query with BeginPagination(), PageSize or PageNumber) fails on SQL Server with "Invalid attempt to read from column ordinal '0'". 1.1.8.8 does not check for updates, so it will not tell you about the fix: download 1.2.0.8 or later once, then Sync your solutions to regenerate the code. The SQL the generated code sends does not change.
From version 1.2.0.8 the app updates itself. It looks for a newer release on GitHub once a day, and when you click Check for updates on the About page. When there is one, it asks "An update is available" and shows what is new; choose Later or Update now.
Update now asks about unsaved changes, downloads the release for your system, checks it, replaces the app (and the sharpfactory command line next to it) and restarts with the model that was open. Cancel on the About page stops the download. Before it installs anything, the app checks that the download matches SHA256SUMS.txt and that The Sharp Factory signed that file; a damaged download, or a release made by anyone else, is refused and nothing changes.
Where the app cannot replace itself, for example in a folder it cannot write to, or on macOS when it was opened straight from Downloads without moving it to Applications, it offers to open the release page so you can download it yourself.
The check sends only the app's name and version to GitHub, and nothing is downloaded until you choose Update now. To turn the automatic check off, clear Check for updates once a day on the About page. The About page also links to the releases on GitHub and to the issue tracker.
No Account Needed#
The Sharp Factory App is free and open source. It does not ask for a login or a subscription, and it does not need an internet connection: it works offline. It connects to the SQL Server database you point it at, and to GitHub only to check for updates, which you can turn off.
Keep It Handy#
Once the application is running you can pin it: on Windows right-click its icon in the taskbar and select "Pin to taskbar", on macOS right-click its icon in the Dock and choose Options > Keep in Dock, and on Linux add it to your desktop's favorites or create a launcher for it.
Next Steps#
Now that you have installed the application you will want to generate your first model. For more information go to Model Generation. There you will find how to create your first model and generate the C# in your solution.