You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+54-16Lines changed: 54 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,35 +26,32 @@ By default, the server uses your locally installed Zig compiler to serve documen
26
26
The CLI provides flexible options for version control and update management:
27
27
28
28
```bash
29
-
# Start MCP server with defaults (master branch, manual updates)
30
-
zig-mcp
29
+
# Start MCP server
30
+
zig-mcp --doc-source local
31
31
32
-
# Use specific Zig version
33
-
zig-mcp --version 0.14.1
32
+
# Use specific Zig version from ziglang.org instead of local Zig
33
+
zig-mcp --doc-source remote --version 0.14.1
34
34
35
35
# Enable automatic daily updates
36
-
zig-mcp --update-policy daily
37
-
38
-
# Use remote documentation from ziglang.org instead of local Zig
39
-
zig-mcp --doc-source remote --version 0.14.1
36
+
zig-mcp --doc-source remote --update-policy daily
40
37
41
-
# Update documentation without starting server
38
+
# Update documentation without starting MCP server (only for remote)
42
39
zig-mcp update --version 0.15.1
43
40
44
41
# Start local web server to view documentation
45
42
zig-mcp view --version 0.15.1
46
43
```
47
44
48
-
**Version options**:
45
+
**Version options`--version`**:
49
46
-`master` (default) - Latest development version from Zig's master branch
50
47
-`0.14.1`, `0.14.0`, etc. - Specific Zig release versions
51
48
52
-
**Update policies**:
49
+
**Update policies`--update-policy`**:
53
50
-`manual` (default) - No automatic updates, manual control only
54
51
-`daily` - Check for documentation updates once per day
55
52
-`startup` - Update documentation every time the server starts
56
53
57
-
**Documentation sources**:
54
+
**Documentation sources`--doc-source`**:
58
55
-`local` (default) - Use your locally installed Zig compiler's documentation server (`zig std`)
59
56
-`remote` - Download documentation from ziglang.org
60
57
@@ -76,15 +73,17 @@ When using `--doc-source remote`, documentation is fetched from ziglang.org and
76
73
77
74
## Installation
78
75
76
+
The installation examples below use the local documentation source by default. In local mode, docs are served by your installed Zig via `zig std`, requiring no network and matching your actual Zig version. This is the recommended setup for most users. For downloading docs from ziglang.org instead, see Remote Documentation (Optional) below.
0 commit comments