Installation

Run the installer for your operating system. It downloads the latest Codeboard release from GitHub, verifies the archive's SHA-256 checksum, and installs it for your user account. No administrator access, Node.js installation, or npm account is needed.

macOS and LinuxCopy Anchor Link

In Terminal:

curl -fsSL https://codeboard.nonom.xyz/install.sh | sh

Open a new terminal, then check:

codeboard --version

The installer supports macOS on Apple Silicon and Intel, and Linux x64 with glibc. It needs curl, tar, and either sha256sum or shasum. Alpine Linux and Linux ARM packages are not available.

Codeboard lives in ~/.local/share/codeboard/versions/. The command is installed in ~/.local/bin/. The installer adds that command directory to your bash, zsh, or login profile. To use it immediately in the current terminal:

export PATH="$HOME/.local/bin:$PATH"

WindowsCopy Anchor Link

In a 64-bit PowerShell window:

& ([scriptblock]::Create((Invoke-RestMethod https://codeboard.nonom.xyz/install.ps1)))
codeboard --version

The installer supports Windows x64. It installs into %LOCALAPPDATA%\Programs\Codeboard, adds its bin directory to your user PATH, and makes the command available in the current PowerShell session. Windows ARM is not supported.

Create your first drawingCopy Anchor Link

Choose a working folder for your artwork, separate from the installation folder:

mkdir my-film
cd my-film
codeboard init
codeboard run scene.mjs

Continue with the quickstart.

Review or pin the installerCopy Anchor Link

You can read the shell installer or PowerShell installer before running it. To install a specific release, download the script and pass a version:

sh install.sh --version 0.2.0

& .\install.ps1 -Version 0.2.0

Update or uninstallCopy Anchor Link

Codeboard checks for a stable GitHub release when you run a command in an interactive terminal, at most once a day. If a newer version is available, it asks Install update? [y/N]. Type y to install, or press Enter to continue without updating. It does not install updates without your confirmation.

codeboard update --check
codeboard update

--check checks immediately without installing. update asks for confirmation, verifies and runs the release installer, then switches your installed command to the new version. Use codeboard update --yes to explicitly authorize installation from a script. Existing version directories are retained. Your projects stay in their working folders and are not changed by the installer. A running command continues using its current version; new commands use the updated version.

Automatic checks are skipped in CI, when output is redirected, and when CODEBOARD_NO_UPDATE_CHECK=1 is set. A daily network check waits at most 1.5 seconds; a failed check never prevents your command from running. Explicit update commands still contact GitHub.

For Codeboard 0.2.0 or a manually extracted archive, run the installer above to get a version with the update command. Source checkouts are updated through Git. To select an older version again, run the installer with its version number.

To uninstall, remove the Codeboard installation directory and command wrapper, then remove its PATH entry from your shell profile or Windows user environment settings. Keep any .cboard files and authoring scripts you want to retain.

Optional toolsCopy Anchor Link

Movie export requires FFmpeg. Install it separately and put ffmpeg on PATH, or supply its path when exporting a movie. Drawing, PNG export, and saving projects work without it.

Fonts are read from your system. Install the fonts your artwork uses, or choose fonts available on your machine. macOS may request approval for downloaded executables in Privacy & Security; the portable packages are not notarized.

Prefer manual installation? Download a matching archive from GitHub Releases, verify it against SHA256SUMS, extract it, and add the directory containing codeboard or codeboard.cmd to PATH. Keep the complete extracted directory together.