From f58e06ddeca494deec1ac89a55bb9fb3b3eab4fa Mon Sep 17 00:00:00 2001 From: DaanSelen Date: Thu, 29 Jan 2026 16:48:44 +0100 Subject: [PATCH] chore: edit readme --- .gitignore | 1 + README.md | 31 ++++++++++++++----------------- 2 files changed, 15 insertions(+), 17 deletions(-) diff --git a/.gitignore b/.gitignore index 3771c16..e7512d3 100644 --- a/.gitignore +++ b/.gitignore @@ -2,6 +2,7 @@ venv books .vscode +important/ # Byte-compiled / optimized / DLL files __pycache__/ diff --git a/README.md b/README.md index 45d2c9d..423a8c5 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ > \[!NOTE] > ๐Ÿ’ฌ If you experience issues or have suggestions, [submit an issue](https://github.com/DaanSelen/meshbook/issues) โ€” I'll respond ASAP! ---- + Meshbook is a tool to **programmatically manage MeshCentral-managed machines**, inspired by tools like [Ansible](https://github.com/ansible/ansible). @@ -17,14 +17,13 @@ Meshbook is designed to: * Allow configuration using simple and readable **YAML files** (like Ansible playbooks). * Simplify the use of **group-based** or **tag-based** device targeting. ---- + ## ๐Ÿ Quick Start ### โœ… Prerequisites -* Python 3.7+ -* Git +* Python 3 * Access to a MeshCentral instance and credentials with: * `Remote Commands` @@ -33,8 +32,6 @@ Meshbook is designed to: A service account with access to the relevant device groups is recommended. ---- - ### ๐Ÿ”ง Installation #### Linux @@ -62,7 +59,7 @@ cp .\templates\meshcentral.conf.template .\meshcentral.conf > ๐Ÿ“Œ Rename `meshcentral.conf.template` to `meshcentral.conf` and fill in your actual connection details. > The URL must start with `wss://`. ---- + ## ๐Ÿš€ Running Meshbook @@ -86,7 +83,7 @@ Use `--help` to explore available command-line options: python3 meshbook.py --help ``` ---- + ## ๐Ÿ› ๏ธ Creating Configurations @@ -95,7 +92,7 @@ Meshbook configurations are written in YAML. Below is an overview of supported f ### โ–ถ๏ธ Group Targeting (Primary*) ```yaml ---- + name: My Configuration group: "Dev Machines" powershell: true @@ -145,7 +142,7 @@ Each task must include: * `name`: Description for human readability. * `command`: The actual shell or PowerShell command. ---- + ## ๐ŸชŸ Windows Client Notes @@ -153,7 +150,7 @@ Each task must include: * Ensure Windows commands are compatible (use `powershell: true` if needed). * Examples are available in [`examples/windows`](./examples/windows). ---- + ## ๐Ÿ”Ž OS & Tag Filtering @@ -177,12 +174,12 @@ target_tag: "Production" > โš ๏ธ Tag values are **case-sensitive**. ---- + ## ๐Ÿ“‹ Example Playbook ```yaml ---- + name: Echo OS Info group: "Dev" target_os: "Linux" @@ -215,7 +212,7 @@ Sample output: } ``` ---- + ## โš ๏ธ Blocking Commands Warning @@ -236,7 +233,7 @@ apt upgrade -y ping 1.1.1.1 -c 1 ``` ---- + ## ๐Ÿงช Check Python Environment @@ -249,7 +246,7 @@ pip3 list The lists should match. If not, make sure the correct environment is activated. ---- + ## ๐Ÿ“‚ Project Structure (excerpt) @@ -275,7 +272,7 @@ meshbook/ โ”‚ โ””โ”€โ”€ config.conf.template ``` ---- + ## ๐Ÿ“„ License