Getting Started

Learn how to get up and running with Mosaic in minutes.

Installation

Automated Install (Recommended)

Windows (PowerShell):

irm https://getmosaic.run/install.ps1 | iex

macOS / Linux:

curl -fsSL https://getmosaic.run/install.sh | sh

Build from Source

If you prefer to build from source (Rust required):

git clone https://github.com/doshibadev/mosaic.git
cd mosaic/cli
cargo install --path .

Your First Project

1. Initialize

Navigate to your Polytoria project folder (where your .poly file is) and run:

mosaic init

This creates a mosaic.toml file:

[package]
name = "my-project"
version = "0.1.0"

2. Install a Package

Let’s install a logging library.

mosaic install logger

Mosaic will:

1. Download the logger package.
2. Inject it into your .poly file under ScriptService.
3. Add it to mosaic.toml.

3. Use it in Code

Open your Polytoria project. You can now require the module just like any other:

-- The package is injected into ScriptService with its package name
local Logger = require(game.ScriptService.logger)
 
Logger:info("Hello from Mosaic!")

Next Steps

• Explore the CLI Reference to see all commands.
• Learn how to Publish a Package.