New ProJor installation method!

We are excited to announce a major improvement to how you can install and use ProJor. Up until now, using ProJor involved downloading the Visual Studio Code extension, running a standalone CLI binary, or using a Docker container. While these options are still available as Legacy Downloads, we are introducing a much more seamless approach tailored for modern Node.js ecosystems.

ProJor is now available on the npm registry as @projor/cli! This brings a host of new, convenient ways to integrate our model-based code generator into your workflow.

New Recommended Installation Methods

The @projor/cli package can be used in several ways, depending on your needs.

1. Run via npx

If you just want to quickly run ProJor without installing it globally or adding it to your project, you can use npx. This is perfect for trying out the tool or running one-off code generations:

npx @projor/cli generate

2. Global Installation

For those who use ProJor frequently across multiple projects, installing the CLI globally makes the projor command available everywhere on your system:

npm install --global @projor/cli
projor generate

3. Project Dependency

The most robust way to ensure reproducible builds in your projects is to add ProJor as a development dependency. This locks down the version of ProJor your project uses and allows other developers to generate code without any extra setup:

npm install --save-dev @projor/cli

Once installed as a dependency, you can run it using npm scripts or simply via npx projor generate.

Legacy Distributions

Don't worry—if you have pipelines or workflows that depend on our previous distributions, we are keeping them around as legacy options. You can still download the standalone executables, the Docker image, and the VS Code extension.

You can find all of the legacy options over at our new Legacy Downloads section on download.projor.io.

Get Started

Check out the updated documentation and quick start guide over at docs.projor.io to see the new installation method in action. We are confident that this new approach will drastically improve your developer experience and simplify how you integrate model-based code generation into your Node.js projects!