DEVELOPMENT.md

BUILDTIME REQUIREMENTS

• a C++ compiler
• Docker 27+
• Go 1.23.3+
• GNU / BSD make
• Rust 1.75.0+
• Snyk
• POSIX compatible tar
• Provision additional dev tools with make -j 4

Recommended

• ASDF 0.10 (run asdf reshim after provisioning)
• direnv 2

Linux

Linux build environments have additional requirements.

• ALSA development headers (Debian: libasound2-dev, RHEL: alsa-lib-devel, Alpine: alsa-lib-dev, etc.)

Non-UNIX environments may produce subtle adverse effects when linting or generating application ports.

Windows

Apply a user environment variable GODEBUG=modcacheunzipinplace=1 per access denied resolution, for native Windows development environments (Command Prompt / PowerShell, not WLS, not Cygwin, not MSYS2, not MinGW, not msysGit, not Git Bash, not etc).

AUDIT

$ mage audit

INSTALL

$ mage install

UNINSTALL

$ mage uninstall

LINT

Keep the code tidy:

$ mage lint

TEST

$ mage [test]

BUILD + PUSH DOCKER IMAGE

$ mage dockerBuild
$ mage dockerPush

PORT

$ mage port