Skip to content

Quickstart

Run the following command to download and install Manul:

Terminal window
curl -sSf https://manul.build/install.sh | sh

This installs Manul to ~/.manul and configures a background service for manul server.

Refresh Your Path

The system PATH is automatically configured, but you’ll need to refresh your terminal session to use the manul command immediately:

  • macOS/Linux: Run source ~/.manul/bin/env.
  • Windows: Restart the terminal.

Verify Installation

Check the version to confirm manul was installed correctly:

Terminal window
manul --version

Create an application named “quickstart”:

Terminal window
manul new quickstart

The command creates an appliction on your manul server and generates a directory with the following structure:

  • Directoryquickstart/
    • src/ example.mnl
    • .manul/ default/ app
  • src/example.mnl is a manul source file containing a Book class.
  • .manul/default/app stores the ID of the application.

Enter the directory and deploy the project:

Terminal window
cd quickstart
manul deploy

Once deployed, manul automatically generates REST API for your application. Send the following HTTP request to create a new book:

POST http://localhost:8080/quickstart/books
{
"title": "The Hobbit",
"author": "J.R.R. Tolkien"
}

The server should responds with the created book.