Introduction

Welcome to the documentation. This guide will walk you through installation, configuration, and your first deployment in under ten minutes.

What you'll build

By the end of this tutorial you will have a working local instance, a basic configuration file, and know how to deploy to production. No prior experience with the toolchain is required.

Install locally →

One-line installer for macOS, Linux, and Windows.

Quick start →

Build and deploy a sample project in 10 minutes.

Configuration →

Reference guide for every configuration option.

CLI reference →

Full command-line reference with examples.

Installation

The recommended way to install is via the official install script:

shell# macOS / Linux curl -fsSL https://get.example.com | sh # verify tool --version

Alternatively you can install via package manager:

shell# Homebrew brew install tool # apt sudo apt install tool # cargo cargo install tool

Requirements: a POSIX-compatible shell and network access to fetch the release binary. No compilation is required on supported platforms.

Your first project

Once installed, initialize a new project and start the development server:

shelltool init hello-world cd hello-world tool dev

The command starts a local server at http://localhost:3000. Any changes to the source files are picked up automatically without needing to restart the process.

Where to next

Read the Configuration guide to customize your project.
Explore the CLI reference for the full command list.
Follow the Deploying to production guide when you're ready.