summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJames O'Doherty <james@theodohertyfamily.com>2026-05-22 11:39:06 -0400
committerJames O'Doherty <james@theodohertyfamily.com>2026-05-22 11:39:06 -0400
commit2e3a1d07b43e6e942e51ba263c6fcdc2351afc0d (patch)
tree2b2afb116b1d45d39016dbfe4489b59a5868571a /README.md
parente5bbb969a15c569cf7d37634234a71783f628390 (diff)
docs: add diagnostic commands to README
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/README.md b/README.md
index 650c3e6..d0a7622 100644
--- a/README.md
+++ b/README.md
@@ -47,6 +47,12 @@ Beyond wrapping commands, `wg-wrap` provides management sub-commands to handle p
- `wg-wrap profile configure <name>`: Opens the selected profile in the system's default editor.
- `wg-wrap profile delete <name>`: Removes the specified profile.
+### Diagnostics
+For debugging and environment verification, `wg-wrap` provides diagnostic tools:
+- `wg-wrap show-config [--profile <name>]`: Displays the current runtime configuration, including resolved paths for the runtime base directory and PID tracking, and verifies whether the process is currently isolated.
+- `wg-wrap test-ns`: Verifies that the process is correctly isolated in a rootless network namespace.
+- `wg-wrap test-args`: Outputs the current process arguments as hex-encoded strings to verify argument integrity through the bootstrap loop.
+
## The Core Architecture
The tool focuses on a direct, transparent data path: