Skip to content

MilosCC/mac-command-cheatsheets

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 

Repository files navigation

mac-command-cheatsheets

Unified, autogenerated macOS command-line cheatsheets built from macOS manpages and enriched with curated external resources.

Overview

This repository is intended to serve as a single, searchable source of truth for macOS command-line usage. The goal is to automatically harvest authoritative details from system manpages, supplement them with concise examples, and publish cheat sheets that are easy to skim on any device.

Planned capabilities

  • Parse macOS manpages into structured data (name, synopsis, options, examples).
  • Normalize content so related commands share a consistent layout and terminology.
  • Enrich each command with quick examples, warnings, and links to deeper references.
  • Export cheat sheets as Markdown for use in terminals, editors, or a static site.

Project status

The automation tooling is still being assembled. As it comes together, the README will be updated with concrete setup steps, generation scripts, and publishing instructions.

Contribution guidelines

  • Keep additions concise and focused on macOS defaults; clearly mark any third-party dependencies.
  • Prefer small, reviewable pull requests with a short summary of what changed and why.
  • Do not commit generated artifacts (e.g., large rendered outputs) until publishing is wired up; keep the repository lean.

Roadmap

  • Baseline parser that converts macOS manpages into structured text.
  • Renderer that outputs Markdown cheat sheets with consistent formatting.
  • Optional static-site output with search and per-command navigation.
  • Quality checks to keep examples accurate and up to date with OS releases.

About

Unified, autogenerated macOS command-line cheatsheets built from manpages and enriched with external resources.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors