Mother DocsMother Docs
Buy me a Coffee
Steam Workshop
Discord
  • Mother OS (Ingame Script)
Buy me a Coffee
Steam Workshop
Discord
  • Mother OS (Ingame Script)
  • Mother OS (Ingame Script)
    • Getting Started

      • Upgrade Guide
      • Installation
      • Command Line Interface (CLI)
      • Configuration
      • Modules
    • Core Modules

      • Activity Monitor
      • Almanac
      • Block Catalogue
      • Local Storage
      • Intergrid Message Service
    • Extension Modules

      • Air Vent Module
      • Battery Module
      • Terminal Block Module
      • Cockpit Module
      • Connector Module
      • Display Module
      • Docking Module
      • Door Module
      • Flight Control Module
      • Flight Planning Module
      • Gas Tank Module
      • Gyroscope Module
      • Hinge Module
      • Landing Gear Module
      • Light Module
      • Map Module
      • Piston Module
      • Programmable Block Module
      • Rotor Module
      • Screen Module
      • Sensor Module
      • Sorter Module
      • Sound Block Module
      • Thruster Module
      • Timer Block Module
    • Command Cheatsheet
    • Compatibility
    • Examples
  • Mother Core (Script Framework)
    • Getting Started

      • Upgrade Guide
      • Installation
      • Architecture Overview
      • Managing Script Size & Complexity
    • Building A Module
    • Console (CLI)
    • Core Modules
      • Activity Monitor
      • Almanac
      • Block Catalogue
      • Clock
      • Command Bus
      • Configuration
      • Event Bus
      • Intergrid Message Service
      • Local Storage
      • Terminal
    • Utilities

      • Color Helper
      • Security
      • Serializer
  • Powered By Mother

Console

You can use Mother CLI to assist with creating projects and many common file types. Simply install it as a global Nuget package and access it with the mother command in your Terminal/Console.

mother make:command CelebrateCommand --module CelebrationModule
  • Installation
  • Usage
  • Available Commands
    • install
    • make:command
    • make:event
    • make:module
    • new
    • update

Installation

Install Mother CLI using the following command in your terminal:

Console/Terminal
dotnet tool install --global Mother.CLI

Usage

Commands use the following format:

mother [command] [arguments] [--options=]

Available Commands

install

Install Mother Core modules. Run this when pulling your project from a remote repo. Since the /Core folder is ignored from version control, think of the this like using npm install or pip install.

You do not have to run this command when creating a new project, as this is done automatically.

mother install

make:command

Create a new terminal command. You may also specific a module to which this command belongs. Mother CLI will register it for you automatically, and place it within the /Modules/{ModuleName}/Commands.

mother make:command [CommandName] --module? [ModuleName]

Example:

# For a module
mother make:command CelebrateCommand --module CelebrationModule

# Without a module
mother make:command CelebrateCommand

make:event

Create a new event. You may also specific a module to which this event belongs. Mother CLI will register it for you automatically, and place it within the /Modules/{ModuleName}/Events.

mother make:event [EventName] --module? [ModuleName]

Example:

# For a module
mother make:event CelebrationStartedEvent --module CelebrationModule

# Without a module
mother make:event CelebrationStartedEvent

make:module

Create a new extension module. A project's modules will be created in the /Modules folder.

mother make:module [ModuleName]

Example:

mother make:module CelebrationModule    

new

Create a new Mother project. This will create a new project in the ProjectName directory, within your current directory. It will also install the latest version of Mother Core to your project.

mother new [ProjectName]
mother new MotherParty

update

Update Mother Core modules. Running this periodically will ensure the Mother Core remains up to date. Think of the this like using npm update or pip install --upgrade to update project dependencies.

mother update

Note

I plan to improve Mother Core versioning in the future to reduce breaking changes introduced by changes to the core modules.

Last Updated: 9/28/25, 8:12 PM
Contributors: lukejamesmorrison, Luke Morrison
Prev
Building a Module
Next
Core Modules