Skip to main content

Setup

Install the command

The desktop app contains the CLI. Install stable symlinks on your PATH:

modular install

The default target is $HOME/.local/bin. It installs modular, the shorter mod alias, and mchat when the terminal chat launcher is available.

modular install --system             # /usr/local/bin
modular install --dir /custom/bin    # custom directory
modular install --force              # replace a different symlink
modular install --uninstall          # remove the symlinks

The installer never replaces a regular file.

Open a workspace

modular .
modular /home/me/project
modular --new-window /home/me/other-project

Useful file operations:

modular --goto src/mod.ts:42:7
modular --diff before.ts after.ts
printf 'scratch text' | modular -
OptionEffect
--new-window, -nopen a new window
--reuse-window, -rreuse the last active window
--wait, -wwait until opened files close
--goto, -gopen file:line[:character]
--diff, -dcompare two files

Check the installation

modular version show
modular status

version show prints the selected app version and installation path. status prints running-process diagnostics.

The standalone CLI can check for and install updates:

modular update --check
modular update

Run modular --help for startup diagnostics, logging, and extension-host inspection options.