Quick Start Guide

This guide will walk you through the basic usage of m-cli to get you up and running in minutes.

1. Listing Available Commands

To see everything m-cli can do, simply run the m command without any arguments. This will display a list of all available command modules (plugins).

m

  Swiss Army Knife for macOS ! 

Usage: m [Options] COMMAND [COMMAND_OPTIONS] [ARGS..]

Options:
  --help          Show this help message
  --update        Update 'm-cli' to the latest version
  --uninstall     Uninstall 'm-cli'
  --version       Show the version of 'm-cli'

COMMANDS:
    airdrop
    appearance
    audio
    battery
    ...

2. Getting Help for a Specific Command

Every command in m-cli has its own detailed help screen. To view it, use the --help flag after the command name. This is the best way to learn about a command's options and arguments.

For example, to see how to manage the Dock:

m dock --help

Usage: m dock [OPTIONS] [ARGUMENTS]

Description: Manage the macOS Dock settings and items

Options:
  --autohide <enable|disable>       Enable or disable the Dock's auto-hide feature
  --autohidedelay SECONDS           Changes how long it takes to detect you want to show up the dock
  --additem PATH                    Add an item to the Dock, e.g. /Applications/Safari.app
  ...

3. Running Your First Commands

Let's try a few simple, non-destructive commands to see m-cli in action.

Check Battery Status:

m battery --status

Show Hidden Files in Finder: This is a common task for developers. With m-cli, it's a one-liner.

m finder --showhiddenfiles enable

To hide them again:

m finder --showhiddenfiles disable

Move the Dock: Let's move the Dock to the right side of the screen.

m dock --position right

To move it back to the bottom:

m dock --position bottom

Next Steps

You've now mastered the basics! The real power of m-cli lies in its rich set of commands. We encourage you to explore the full Commands Reference to discover all the ways you can manage your Mac more efficiently.