https://github.com/astzweig/macos-system

💼 Astzweig system setup for macOS
https://github.com/astzweig/macos-system

Last synced: about 2 months ago
JSON representation

💼 Astzweig system setup for macOS

• Host: GitHub
• URL: https://github.com/astzweig/macos-system
• Owner: astzweig
• License: eupl-1.2
• Created: 2022-01-22T23:06:23.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-07-21T23:27:34.000Z (6 months ago)
• Last Synced: 2024-07-22T00:32:36.822Z (6 months ago)
• Language: Shell
• Size: 170 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# macOS System

Scripts to align a macOS system to Astzweig system configuration.

## Install

```zsh

/bin/zsh -c "$(curl -fsSL https://raw.githubusercontent.com/astzweig/macos-system/main/bootstrap.sh)"

```

## What it does

1. Run all setup from a temporary directory and delete it in the end

## Process

1. `install.sh` queries all modules for their required information

1. The modules print their required information to stdout using the format as described below.

1. `install.sh` parses those informations and tries to read them from a configuration file.

1. If the configuration file does not have those informations, it asks the user.

1. `install.sh` then runs the modules with their required informations passed in as parameter values.

## License exclusion

The license does not cover the file [Astzweig.png](resources/user-pictures/Astzweig.png).

## Required Information Format

Modules must print their required information to stdout if they're called with

`show-questions` command. Required information are all information the module

might want to ask the user in order to configure some aspect of the system.

### Schema

The general schema is:

```zsh

#(i|p|c|s): = [# (: ) [(; : )...]]

s: --highlight-color=What color shall your system highlight color be? # choose from: blue,red,light green;

p: --user-password=What color shall your system highlight color be?

```

The letter at the beginning is the question type:

| Question type | Description | Arguments |

| ------------- | ----------- | --------- |

| i (info) | A question where the user has no restrictions on input | `default`: a default answer. |

| p (password) | A question where the user input is not printed to standard output. | - |

| c (confirm) | A yes/no question where the user is allowed to answer yes or no. | - |

| s (select) | A list of choices where the user can select one using numbers. | `choose from`: a comma separated list of possible select values. |

`` is the the parameter name, that will receive the user answer

when the module is called. Single char parameter names will be prefixed with a

single dash while multi char parameter names will be prefixed by double dashes.

E.g. the parameter name `s` becomes `-s ` on module call, while

the parameter name `highlight-color` becomes `--highlight-color `.

`` must contain any punctuation you want to show.

[^zshlib-askUser]: Currently supported: info, password, confirm, choose. They map to [zshlib/askUser][zshlib-overview] commands.

[zshlib-overview]: https://github.com/astzweig/zshlib#whats-included