Morphz Docs

Getting started

Install Morphz, configure a model path, and receive the first real response.

Morphz ships as a prebuilt native binary with the Dashboard embedded. The first-run path covers installation, model configuration, and a live response check.

Prerequisites

  • macOS on Apple Silicon or Intel, x86_64 Linux, or x86_64 Windows;
  • Access to at least one model service;
  • Read and write access to the working directory.

Install with one command

macOS and Linux:

curl -fsSL https://morphz.ai/install.sh | sh

Windows PowerShell:

irm https://morphz.ai/install.ps1 | iex

The installer detects the current platform, downloads the matching archive from GitHub Releases, verifies its SHA-256 checksum, and installs into the user path without requiring root or administrator access. Open a new terminal before continuing with Setup.

Updates are explicit and reuse the same verified GitHub Release assets:

morphz update status
morphz update

A successful update retains the previous main binary; use morphz update rollback when needed. The standalone morphz-edge Execution Target client follows a separate installation and update flow.

Complete Setup

Setup opens the Dashboard wizard by default:

morphz setup

Use the full-screen terminal wizard on SSH hosts or systems without a browser:

morphz setup --tui

To print the Dashboard URL without opening a browser:

morphz setup --no-open

A successful Setup persists a complete model service, auth account, and model route. An OAuth account becomes selectable after its login flow completes successfully.

Verify the model path

Run the structural diagnostics first:

morphz doctor

Then open Model Services in the Dashboard and test the account. Authentication confirms that credentials are stored; the account test also verifies the selected account, physical model, and live request path, and reports elapsed time or errors.

Start the first conversation

Launch the interactive interface:

morphz

Or provide a prompt directly:

morphz inspect this project and explain what you can access

When the Dashboard displays a model response, the model path is verified and Morphz is ready for work. If the page shows only user messages, keep the current Session and trace its model request path with Operations and troubleshooting.

Build from source

From the repository root, use the Rust toolchain pinned by rust-toolchain.toml:

cargo build --release

The resulting binary is target/release/morphz. Source builds support development, review, and independent reproduction; ordinary users can use the one-command installer above.

Next steps