Skip to content

DOCUMENTATION.md

Latest commit

 

History

History
142 lines (121 loc) · 3.62 KB

DOCUMENTATION.md

File metadata and controls

142 lines (121 loc) · 3.62 KB
Raw

MASTerm Manual 📘

The Complete Guide to Mastering Your Terminal

📚 Table of Contents

  1. Introduction
  2. Installation
  3. Getting Started
  4. Prompt Engine
  5. Features Deep Dive
  6. Plugin System
  7. Advanced Configuration
  8. Troubleshooting

1. Introduction

MASTerm is a next-generation terminal framework written in Rust. It replaces your shell prompt with a high-performance, intelligent, and beautiful alternative that works across Zsh, Bash, and Fish.

2. Installation

One-Line Install

curl -fsSL https://raw.githubusercontent.com/singhalmridul/MASTerm/main/install.sh | bash

Manual Build

git clone https://github.com/singhalmridul/MASTerm.git
cd MASTerm
cargo install --path crates/masterm-cli
masterm install

3. Getting Started

Interactive Setup

Configuring a terminal shouldn't require editing a text file. Run the wizard:

masterm setup

You will be asked about:

  • Icons: Nerd Fonts vs Unicode
  • Theme: Catppuccin, Dracula, or Nord
  • Safety: Dev vs Ops mode

The Welcome Screen

Upon logging in, you'll see a dashboard with:

  • ASCII Art Banner
  • CPU/Memory Usage
  • Active Shell Version If it's missing, run masterm welcome manually.

4. Prompt Engine

The prompt is divided into:

  • Left: Contextual info (Dir, Git, Language Version)
  • Right: Metadata (Duration, Time)

Themes

Set in ~/.masterm.toml:

[prompt.colors]
theme = "dracula" # or "catppuccin", "nord"

5. Features Deep Dive

Production Safety Guards

MASTerm detects if you are in a "Production" environment (via ENV vars or git branch). If you run rm -rf while in Production: IT BLOCK/WARNS YOU. Configure this in [safety]:

dangerous_commands = ["rm -rf", "DROP DATABASE"]

TUI Dashboard

Run masterm dashboard to see a full-screen terminal UI monitor.

  • Tab 1: System Monitor (REAL-TIME graphs)
  • Tab 2: Configuration Viewer

AI Command Assistance

Convert natural language to shell commands:

masterm ask "how to check disk space"

It provides a safe, explained command with a risk rating.

Workflow Automation

Create a workflows.toml file in your project:

[deploy]
description = "Build and ship"
steps = ["cargo test", "./deploy.sh"]

Run it:

masterm run deploy

6. Plugin System

Marketplace

Find new capabilities without leaving the terminal:

masterm plugins search <query>
masterm plugins install <name>

Architecture (WASM)

Plugins are WebAssembly modules. They run in a sandboxed environment with strict permissions defined in plugin.toml.

7. Advanced Configuration

Enterprise.toml

Admins can enforce settings globally via /etc/masterm/enterprise.toml. Useful for teams requiring specific safety checks.

8. Troubleshooting

Something wrong? Run the doctor:

masterm doctor

Uninstalling

masterm install --uninstall
rm -rf ~/.masterm