vix note starts the Vix Note workspace.

Use it to open an interactive note UI, run note cells, work from the current project directory, or export a .vixnote document to a standalone HTML lesson.

vix note

vix note runs a local Vix Note server.

Without a file, it starts a workspace for the current directory.

vix note

With a .vixnote file, it loads that document.

vix note lessons/pointers.vixnote

The command exposes the note UI through HTTP.

http://127.0.0.1:5179/

It can also open the note UI inside a desktop WebView shell when desktop shell support is available.

vix note --desktop

vix note [file.vixnote] [options]
vix note export <file.vixnote> --out <file.html> [options]

vix note

This starts a note workspace in the current directory.

Vix creates an untitled note document in memory and uses the current folder as the project context.

Example output shape:

Vix Note
  HTTP: http://127.0.0.1:5179/
  Status: listening

vix note examples/hello.vixnote

A note file must use the .vixnote extension.

vix note lessons/pointers.vixnote

Use a custom port:

vix note lessons/pointers.vixnote --port 5180

Use a custom host:

vix note lessons/pointers.vixnote --host 127.0.0.1 --port 5179

vix note --desktop

or:

vix note lessons/pointers.vixnote --desktop

Desktop mode starts the local note server, waits until it is ready, then opens the note UI inside a desktop shell.

Set the desktop window size:

vix note lessons/pointers.vixnote --desktop --width 1400 --height 900

Enable developer tools:

vix note --desktop --devtools

Start fullscreen:

vix note --desktop --fullscreen

Disable resizing:

vix note --desktop --no-resizable

Use browser/server mode explicitly:

vix note --browser

vix note export examples/hello.vixnote --out hello.html

This exports the .vixnote document to a standalone HTML lesson.

Export without cell outputs:

vix note export examples/hello.vixnote --out hello.html --no-outputs

Export with outputs:

vix note export examples/hello.vixnote --out hello.html --with-outputs

Cell outputs are included by default.

Start notes for the current project:

vix note

Open a saved lesson:

vix note lessons/cpp-basics.vixnote

Open a note on another port:

vix note lessons/cpp-basics.vixnote --port 5180

Open the note UI as a desktop app:

vix note lessons/cpp-basics.vixnote --desktop

Export a lesson to HTML:

vix note export lessons/cpp-basics.vixnote --out cpp-basics.html

Export a clean lesson without outputs:

vix note export lessons/cpp-basics.vixnote --out cpp-basics.html --no-outputs

Use JSON lifecycle events:

vix note lessons/cpp-basics.vixnote --json

Run quietly:

vix note lessons/cpp-basics.vixnote --quiet

When the note server is running, the main routes are:

Wrong:

vix note lesson.md

Correct:

vix note lesson.vixnote

vix note expects .vixnote files.

Wrong:

vix note --port 999999

Correct:

vix note --port 5179

The port must be between 1 and 65535.

Wrong:

vix note export lessons/pointers.vixnote

Correct:

vix note export lessons/pointers.vixnote --out pointers.html

vix note --desktop

Desktop mode requires the CLI to be built with UI shell support.

When it is not available, use browser/server mode:

vix note --browser

Check the path:

vix note lessons/pointers.vixnote

The file must exist and must be a regular .vixnote file.

Use another port:

vix note --port 5180

Another process may already be using the default port.

Use normal server mode:

vix note

Then open the printed local URL in your browser.

The CLI must be built with Note support enabled.

cmake -S . -B build -DVIX_ENABLE_NOTE=ON
cmake --build build -j