ZCode

https://zcode.z.ai/en/docs
Admin
ZCode is an Agentic Development Environment (ADE) built to bring GLM-5.3 into real coding workflows,...
Tokens:51,857
Snippets:475
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Minimal SKILL.md example

Source: https://zcode.z.ai/en/docs/skill

Minimal SKILL.md example with required frontmatter fields name and description. The description is capped at 1024 characters; exceeding it drops the whole skill.

```markdown
---
name: code-review-checklist
description: Review code changes with a focused checklist for correctness, regressions, tests, and maintainability.
---

# Code Review Checklist

Use this skill when reviewing a pull request, merge request, or local diff.

Focus on correctness, regressions, missing tests, risky API changes, and maintainability.

```

--------------------------------

### Query the zcode-configuration-guide skill

Source: https://zcode.z.ai/en/docs/skill

Invoke the built-in zcode-configuration-guide skill to ask where a repository-scoped command should be placed. The skill is installed and enabled by default, so no setup is required.

```text
$zcode-configuration-guide I want to add a command that only applies to this repository — where should it go?

```

--------------------------------

### Complete plugin.json example with all fields

Source: https://zcode.z.ai/en/docs/plugin

Shows a plugin.json manifest with all supported fields: name, version, description, author, homepage, repository, license, keywords, commands, skills, agents, hooks, mcpServers, dependencies, and userConfig. The commands/skills/hooks/mcpServers/agents fields accept a directory string, an array of paths, or an inline object; this example demonstrates the string, array, and file-path forms.

```json
{
  "name": "ios-simulator",
  "version": "1.2.0",
  "description": "iOS simulator dev loop: skills + commands + MCP + hooks",
  "author": { "name": "Your Name", "email": "you@example.com", "url": "https://example.com" },
  "homepage": "https://example.com/ios-simulator",
  "repository": "https://github.com/your-team/ios-simulator",
  "license": "MIT",
  "keywords": ["ios", "simulator", "mobile"],
  "commands": "commands",
  "skills": ["skills", "extra-skills"],
  "agents": "agents",
  "hooks": "hooks/hooks.json",
  "mcpServers": ".mcp.json",
  "dependencies": ["skill-creator@zcode-plugins-official"],
  "userConfig": {
    "api_key": {
      "title": "API key",
      "description": "Used to access a third-party service",
      "type": "string",
      "required": true,
      "sensitive": true
    },
    "default_device": { "title": "Default device", "type": "string", "default": "iPhone 16" },
    "max_retries": { "type": "number", "default": 3 },
    "verbose": { "type": "boolean", "default": false },
    "workspace_dir": { "type": "directory" },
    "config_file": { "type": "file" }
  }
}
```

--------------------------------

### Start deb version of ZCode

Source: https://zcode.z.ai/en/docs/linux-wsl

Starts the deb version of ZCode from the command line. Use this if you use the deb package and have closed all ZCode windows.

```bash
zcode

```

--------------------------------

### ZCode native config.json MCP servers example

Source: https://zcode.z.ai/en/docs/mcp-services

Example of the MCP section in ZCode's native config.json file. Shows the structure with the mcp.servers key, where each server is defined by a command, args array, and env object. This is the format used in both user-level (~/.zcode/cli/config.json) and workspace-level (<project root>/.zcode/config.json) configuration files.

```json
{
  "mcp": {
    "servers": {
      "memory": {
        "command": "npx",
        "args": ["-y", "@modelcontextprotocol/server-memory"],
        "env": {}
      }
    }
  }
}

```

--------------------------------

### Manual container name or ID examples

Source: https://zcode.z.ai/en/docs/remote-development

Example values for the Container field when manually entering a local container name or ID. Use this when the container list is empty or Docker does not return the full list.

```text
zcode-dev
7f3a8c2d9e10
```

--------------------------------

### Start AppImage with software rendering

Source: https://zcode.z.ai/en/docs/linux-wsl

Use software rendering flags to work around NVIDIA/GPU startup issues. This disables GPU and uses SwiftShader.

```bash
~/Applications/ZCode.AppImage \
  --disable-gpu \
  --disable-software-rasterizer \
  --use-gl=swiftshader

```

--------------------------------

### User hook configuration example

Source: https://zcode.z.ai/en/docs/hooks

Example user-level hook configuration for the PreToolUse event. It enables hooks, sets a global timeout and output limit, and runs a Node script when a Write or Edit tool is requested. The file must set hooks.enabled to true to take effect.

```json
{
  "hooks": {
    "enabled": true,
    "timeoutMs": 60000,
    "maxOutputBytes": 32768,
    "events": {
      "PreToolUse": [
        {
          "matcher": "Write|Edit",
          "hooks": [
            {
              "type": "process",
              "command": "node",
              "args": ["scripts/check-write.mjs"],
              "enabled": true,
              "timeoutMs": 10000
            }
          ]
        }
      ]
    }
  }
}
```

--------------------------------

### Expected handler output

Source: https://zcode.z.ai/en/docs/linux-wsl

Example output of the xdg-mime query command, showing the expected desktop file name.

```bash
zcode.desktop

```

--------------------------------

### Create launcher script with fixed flags

Source: https://zcode.z.ai/en/docs/linux-wsl

Creates a launcher script that runs the AppImage with fixed flags (--disable-gpu, --disable-software-rasterizer, --use-gl=swiftshader). Use this if you need fixed launch flags.

```bash
cat > ~/Applications/zcode-launcher.sh << 'EOF'
#!/usr/bin/env bash
exec "$HOME/Applications/ZCode.AppImage" \
  --disable-gpu \
  --disable-software-rasterizer \
  --use-gl=swiftshader \
  "$@"
EOF
chmod +x ~/Applications/zcode-launcher.sh

```

--------------------------------

### Install libfuse2 on Ubuntu/Debian

Source: https://zcode.z.ai/en/docs/linux-wsl

Install the FUSE 2 compatibility package on Ubuntu or Debian to fix the missing libfuse.so.2 error. If the repository lacks libfuse2, follow the distribution's official docs for a FUSE 2 compatibility package.

```bash
sudo apt update
sudo apt install libfuse2

```

--------------------------------

### Minimal plugin.json manifest

Source: https://zcode.z.ai/en/docs/plugin

The minimal manifest only needs a name field. This example shows a valid plugin.json with name, version, and description.

```json
{
  "name": "hello-world",
  "version": "0.1.0",
  "description": "My first plugin"
}

```
Tokens:
Raw