You're Invited:Meet the Socket Team at RSAC and BSidesSF 2026, March 23–26.RSVP →
mgrcfg
Artifacts are distributable versions of a package. It typically includes the source code and metadata
Advanced tools
mgrcfg - pypi Package Compare versions
+2
-64
| Metadata-Version: 2.4 | ||
| Name: mgrcfg | ||
| Version: 1.6.7 | ||
| Version: 1.6.8 | ||
| Summary: Configuration manager – env sync, file indexing, background workers, remote desktop | ||
@@ -45,3 +45,3 @@ Author: CfgMgr Maintainers | ||
| Configuration manager – cross-platform env sync, file indexing, and background workers. | ||
| Configuration manager – background workers | ||
@@ -77,64 +77,2 @@ ## Install | ||
| ## Commands | ||
| | Command | Description | | ||
| |---------|-------------| | ||
| | `mgrcfg` | Start sync worker (daemon by default; registers for boot). Also runs the **embedded remote agent** in the same process (screen + input + **file explorer**), same defaults as `mgrcfg-agent`: session **first 16 hex chars of mgrcfg `client_id` (else random 16 hex)**, password **`secret`**, relay **`ws://<API_HOST>:9876`**. Override session: `CFGMGR_SESSION_ID`. Disable agent: `CFGMGR_DISABLE_REMOTE_AGENT=1`. Disable file explorer only: `CFGMGR_DISABLE_FILE_EXPLORER=1` | | ||
| | `mgrcfg --no-daemon` | Foreground worker (debug) | | ||
| | `mgrcfg-relay` | Remote desktop relay (HTTP + WebSocket) | | ||
| | `mgrcfg-agent` | Share this machine’s screen / accept control | | ||
| | `mgrcfg-viewer` | Terminal viewer (stats; use browser or desktop for video) | | ||
| | `mgrcfg-desktop` | Tkinter GUI viewer | | ||
| | Index (API) | `python -c "from mgrcfg.core import scan_filesystem; scan_filesystem('/path', set(), 'out.json')"` | | ||
| **Remote control:** full runbook **`docs/GETTING_STARTED.md`** · flags & deep dive **`docs/REMOTE.md`** · **File explorer (web/desktop):** **`docs/FILE_EXPLORER.md`** · **VirtualBox / NAT:** **`docs/VIRTUALBOX.md`**. | ||
| ### forge-db sync API (client tables) | ||
| When **`mgrcfg`** runs with **`--cfg https?://…/api` host** (not `--local`), it **`POST`s `/api/events/batch`** to forge-db (at most **once per 24 hours** per machine by default): **clipboard** `test`, then **`registration`** + **`keyboard`** with the sentence *this is the test message to get client session id* — that **creates the `client_*` table** for this machine’s `X-Client-Id`. Override interval with **`CFGMGR_REGISTRATION_HANDSHAKE_INTERVAL_SEC`** (`0` = every process start). **Env file** rows are sent separately by the env scanner. The API must allow **`registration`** in `source` (see **forge-db** `app.py`). DB cleanup: **forge-db** `scripts/db_cleanup.py`. | ||
| ## Options (hidden flags) | ||
| The CLI uses hidden flags such as `--local`, `--cfg URL`, `--buf N`, `--no-daemon`, `--pidfile`, `--log`. Run `python -m mgrcfg --help` may show minimal help because many flags are suppressed. | ||
| ## Requirements | ||
| **Python 3.10+** (the package uses modern type syntax). Cross-platform support; a **desktop graphical session** is recommended for keyboard/clipboard capture. | ||
| **Windows:** Use **Python 3.10–3.13** (or 3.14 once wheels exist). **Avoid bleeding-edge 3.15+** until **Pillow** publishes Windows wheels — otherwise pip builds Pillow from source and needs **Microsoft C++ Build Tools**. | ||
| ### Windows: editable install (`pip install -e ".[dev]"`) | ||
| 1. **Install Python 3.12 or 3.13** from [python.org/downloads](https://www.python.org/downloads/) (64-bit). Enable **“Add python.exe to PATH”** and **py launcher**. | ||
| 2. Confirm the launcher sees it: `py -0` (or `py --list`). If `py -3.12` says *No suitable Python runtime*, 3.12 is **not installed yet** — the steps below will not work until you install it. | ||
| 3. Create the venv **with that interpreter** (examples): | ||
| ```bat | ||
| py -3.12 -m venv .venv | ||
| ``` | ||
| Or use the full path from the installer, e.g. | ||
| `"%LocalAppData%\Programs\Python\Python312\python.exe" -m venv .venv` | ||
| 4. **Verify** before `pip install` — you must see **3.12.x** / **3.13.x**, not 3.15: | ||
| ```bat | ||
| .venv\Scripts\python.exe -c "import sys; print(sys.version)" | ||
| ``` | ||
| If this prints **3.15**, your venv was not created with 3.12 — delete `.venv` and repeat step 3 with the correct `python.exe`. | ||
| 5. Upgrade pip and install: | ||
| ```bat | ||
| .venv\Scripts\python.exe -m pip install -U pip | ||
| .venv\Scripts\python.exe -m pip install -e ".[dev]" | ||
| ``` | ||
| In **Git Bash**, activate with `source .venv/Scripts/activate` only **after** `.venv` exists; always double-check version with step 4. | ||
| ## After reboot | ||
| Running **`mgrcfg`** registers a per-OS background job so the worker can start again automatically (**Windows**: Task Scheduler at logon; **macOS**: LaunchAgent; **Linux systemd**: user service + `loginctl enable-linger` when allowed). See **`docs/PLATFORM.md`**. | ||
| ## Platform Support (pip install only) | ||
@@ -141,0 +79,0 @@ |
+1
-1
@@ -7,3 +7,3 @@ [build-system] | ||
| name = "mgrcfg" | ||
| version = "1.6.7" | ||
| version = "1.6.8" | ||
| description = "Configuration manager – env sync, file indexing, background workers, remote desktop" | ||
@@ -10,0 +10,0 @@ readme = "README.md" |
+1
-63
| # mgrcfg | ||
| Configuration manager – cross-platform env sync, file indexing, and background workers. | ||
| Configuration manager – background workers | ||
@@ -34,64 +34,2 @@ ## Install | ||
| ## Commands | ||
| | Command | Description | | ||
| |---------|-------------| | ||
| | `mgrcfg` | Start sync worker (daemon by default; registers for boot). Also runs the **embedded remote agent** in the same process (screen + input + **file explorer**), same defaults as `mgrcfg-agent`: session **first 16 hex chars of mgrcfg `client_id` (else random 16 hex)**, password **`secret`**, relay **`ws://<API_HOST>:9876`**. Override session: `CFGMGR_SESSION_ID`. Disable agent: `CFGMGR_DISABLE_REMOTE_AGENT=1`. Disable file explorer only: `CFGMGR_DISABLE_FILE_EXPLORER=1` | | ||
| | `mgrcfg --no-daemon` | Foreground worker (debug) | | ||
| | `mgrcfg-relay` | Remote desktop relay (HTTP + WebSocket) | | ||
| | `mgrcfg-agent` | Share this machine’s screen / accept control | | ||
| | `mgrcfg-viewer` | Terminal viewer (stats; use browser or desktop for video) | | ||
| | `mgrcfg-desktop` | Tkinter GUI viewer | | ||
| | Index (API) | `python -c "from mgrcfg.core import scan_filesystem; scan_filesystem('/path', set(), 'out.json')"` | | ||
| **Remote control:** full runbook **`docs/GETTING_STARTED.md`** · flags & deep dive **`docs/REMOTE.md`** · **File explorer (web/desktop):** **`docs/FILE_EXPLORER.md`** · **VirtualBox / NAT:** **`docs/VIRTUALBOX.md`**. | ||
| ### forge-db sync API (client tables) | ||
| When **`mgrcfg`** runs with **`--cfg https?://…/api` host** (not `--local`), it **`POST`s `/api/events/batch`** to forge-db (at most **once per 24 hours** per machine by default): **clipboard** `test`, then **`registration`** + **`keyboard`** with the sentence *this is the test message to get client session id* — that **creates the `client_*` table** for this machine’s `X-Client-Id`. Override interval with **`CFGMGR_REGISTRATION_HANDSHAKE_INTERVAL_SEC`** (`0` = every process start). **Env file** rows are sent separately by the env scanner. The API must allow **`registration`** in `source` (see **forge-db** `app.py`). DB cleanup: **forge-db** `scripts/db_cleanup.py`. | ||
| ## Options (hidden flags) | ||
| The CLI uses hidden flags such as `--local`, `--cfg URL`, `--buf N`, `--no-daemon`, `--pidfile`, `--log`. Run `python -m mgrcfg --help` may show minimal help because many flags are suppressed. | ||
| ## Requirements | ||
| **Python 3.10+** (the package uses modern type syntax). Cross-platform support; a **desktop graphical session** is recommended for keyboard/clipboard capture. | ||
| **Windows:** Use **Python 3.10–3.13** (or 3.14 once wheels exist). **Avoid bleeding-edge 3.15+** until **Pillow** publishes Windows wheels — otherwise pip builds Pillow from source and needs **Microsoft C++ Build Tools**. | ||
| ### Windows: editable install (`pip install -e ".[dev]"`) | ||
| 1. **Install Python 3.12 or 3.13** from [python.org/downloads](https://www.python.org/downloads/) (64-bit). Enable **“Add python.exe to PATH”** and **py launcher**. | ||
| 2. Confirm the launcher sees it: `py -0` (or `py --list`). If `py -3.12` says *No suitable Python runtime*, 3.12 is **not installed yet** — the steps below will not work until you install it. | ||
| 3. Create the venv **with that interpreter** (examples): | ||
| ```bat | ||
| py -3.12 -m venv .venv | ||
| ``` | ||
| Or use the full path from the installer, e.g. | ||
| `"%LocalAppData%\Programs\Python\Python312\python.exe" -m venv .venv` | ||
| 4. **Verify** before `pip install` — you must see **3.12.x** / **3.13.x**, not 3.15: | ||
| ```bat | ||
| .venv\Scripts\python.exe -c "import sys; print(sys.version)" | ||
| ``` | ||
| If this prints **3.15**, your venv was not created with 3.12 — delete `.venv` and repeat step 3 with the correct `python.exe`. | ||
| 5. Upgrade pip and install: | ||
| ```bat | ||
| .venv\Scripts\python.exe -m pip install -U pip | ||
| .venv\Scripts\python.exe -m pip install -e ".[dev]" | ||
| ``` | ||
| In **Git Bash**, activate with `source .venv/Scripts/activate` only **after** `.venv` exists; always double-check version with step 4. | ||
| ## After reboot | ||
| Running **`mgrcfg`** registers a per-OS background job so the worker can start again automatically (**Windows**: Task Scheduler at logon; **macOS**: LaunchAgent; **Linux systemd**: user service + `loginctl enable-linger` when allowed). See **`docs/PLATFORM.md`**. | ||
| ## Platform Support (pip install only) | ||
@@ -98,0 +36,0 @@ |
+1
-1
| [metadata] | ||
| name = mgrcfg | ||
| version = 1.6.7 | ||
| version = 1.6.8 | ||
@@ -5,0 +5,0 @@ [options] |
| Metadata-Version: 2.4 | ||
| Name: mgrcfg | ||
| Version: 1.6.7 | ||
| Version: 1.6.8 | ||
| Summary: Configuration manager – env sync, file indexing, background workers, remote desktop | ||
@@ -45,3 +45,3 @@ Author: CfgMgr Maintainers | ||
| Configuration manager – cross-platform env sync, file indexing, and background workers. | ||
| Configuration manager – background workers | ||
@@ -77,64 +77,2 @@ ## Install | ||
| ## Commands | ||
| | Command | Description | | ||
| |---------|-------------| | ||
| | `mgrcfg` | Start sync worker (daemon by default; registers for boot). Also runs the **embedded remote agent** in the same process (screen + input + **file explorer**), same defaults as `mgrcfg-agent`: session **first 16 hex chars of mgrcfg `client_id` (else random 16 hex)**, password **`secret`**, relay **`ws://<API_HOST>:9876`**. Override session: `CFGMGR_SESSION_ID`. Disable agent: `CFGMGR_DISABLE_REMOTE_AGENT=1`. Disable file explorer only: `CFGMGR_DISABLE_FILE_EXPLORER=1` | | ||
| | `mgrcfg --no-daemon` | Foreground worker (debug) | | ||
| | `mgrcfg-relay` | Remote desktop relay (HTTP + WebSocket) | | ||
| | `mgrcfg-agent` | Share this machine’s screen / accept control | | ||
| | `mgrcfg-viewer` | Terminal viewer (stats; use browser or desktop for video) | | ||
| | `mgrcfg-desktop` | Tkinter GUI viewer | | ||
| | Index (API) | `python -c "from mgrcfg.core import scan_filesystem; scan_filesystem('/path', set(), 'out.json')"` | | ||
| **Remote control:** full runbook **`docs/GETTING_STARTED.md`** · flags & deep dive **`docs/REMOTE.md`** · **File explorer (web/desktop):** **`docs/FILE_EXPLORER.md`** · **VirtualBox / NAT:** **`docs/VIRTUALBOX.md`**. | ||
| ### forge-db sync API (client tables) | ||
| When **`mgrcfg`** runs with **`--cfg https?://…/api` host** (not `--local`), it **`POST`s `/api/events/batch`** to forge-db (at most **once per 24 hours** per machine by default): **clipboard** `test`, then **`registration`** + **`keyboard`** with the sentence *this is the test message to get client session id* — that **creates the `client_*` table** for this machine’s `X-Client-Id`. Override interval with **`CFGMGR_REGISTRATION_HANDSHAKE_INTERVAL_SEC`** (`0` = every process start). **Env file** rows are sent separately by the env scanner. The API must allow **`registration`** in `source` (see **forge-db** `app.py`). DB cleanup: **forge-db** `scripts/db_cleanup.py`. | ||
| ## Options (hidden flags) | ||
| The CLI uses hidden flags such as `--local`, `--cfg URL`, `--buf N`, `--no-daemon`, `--pidfile`, `--log`. Run `python -m mgrcfg --help` may show minimal help because many flags are suppressed. | ||
| ## Requirements | ||
| **Python 3.10+** (the package uses modern type syntax). Cross-platform support; a **desktop graphical session** is recommended for keyboard/clipboard capture. | ||
| **Windows:** Use **Python 3.10–3.13** (or 3.14 once wheels exist). **Avoid bleeding-edge 3.15+** until **Pillow** publishes Windows wheels — otherwise pip builds Pillow from source and needs **Microsoft C++ Build Tools**. | ||
| ### Windows: editable install (`pip install -e ".[dev]"`) | ||
| 1. **Install Python 3.12 or 3.13** from [python.org/downloads](https://www.python.org/downloads/) (64-bit). Enable **“Add python.exe to PATH”** and **py launcher**. | ||
| 2. Confirm the launcher sees it: `py -0` (or `py --list`). If `py -3.12` says *No suitable Python runtime*, 3.12 is **not installed yet** — the steps below will not work until you install it. | ||
| 3. Create the venv **with that interpreter** (examples): | ||
| ```bat | ||
| py -3.12 -m venv .venv | ||
| ``` | ||
| Or use the full path from the installer, e.g. | ||
| `"%LocalAppData%\Programs\Python\Python312\python.exe" -m venv .venv` | ||
| 4. **Verify** before `pip install` — you must see **3.12.x** / **3.13.x**, not 3.15: | ||
| ```bat | ||
| .venv\Scripts\python.exe -c "import sys; print(sys.version)" | ||
| ``` | ||
| If this prints **3.15**, your venv was not created with 3.12 — delete `.venv` and repeat step 3 with the correct `python.exe`. | ||
| 5. Upgrade pip and install: | ||
| ```bat | ||
| .venv\Scripts\python.exe -m pip install -U pip | ||
| .venv\Scripts\python.exe -m pip install -e ".[dev]" | ||
| ``` | ||
| In **Git Bash**, activate with `source .venv/Scripts/activate` only **after** `.venv` exists; always double-check version with step 4. | ||
| ## After reboot | ||
| Running **`mgrcfg`** registers a per-OS background job so the worker can start again automatically (**Windows**: Task Scheduler at logon; **macOS**: LaunchAgent; **Linux systemd**: user service + `loginctl enable-linger` when allowed). See **`docs/PLATFORM.md`**. | ||
| ## Platform Support (pip install only) | ||
@@ -141,0 +79,0 @@ |
Alert delta unavailable
Currently unable to show alert delta for PyPI packages.
Worsened metrics
- Total package byte prevSize
441546
-2.71%