{
  "markdown": "# HuaweiCloud DevKit\n\n[![Discussions](https://img.shields.io/badge/Discussions-Join%20the%20discussion-blue)](https://github.com/huaweicloud/huaweicloud-devkit/discussions)\n[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)\n[![CI](https://github.com/huaweicloud/huaweicloud-devkit/actions/workflows/ci.yml/badge.svg)](https://github.com/huaweicloud/huaweicloud-devkit/actions/workflows/ci.yml)\n[![Beta](https://img.shields.io/badge/beta-v1.1.0-orange)](https://github.com/huaweicloud/huaweicloud-devkit)\n\n**[中文](README.zh-CN.md) | English**\n\nHelp AI coding agents use Huawei Cloud safely and accurately — a single integration that gives agents cloud knowledge, CLI tooling, and safety guardrails.\n\nSupports OpenCode, Codex, CodeArts Agent, WorkBuddy, DeepSeek Harness (DSH), OfficeAce, Hermes, OpenClaw, and AtomCode.\n\n## Cursor Directory Plugin\n\nThis repository also acts as an [Open Plugins](https://open-plugins.com) package for the [Cursor Directory](https://cursor.directory) marketplace. The root-level `plugin.json`, `mcp.json`, `skills/`, and `rules/` files are used **only** for Cursor Directory repository-scan discovery and are **not** shipped in the npm tarball (the `package.json` `files` whitelist excludes them). The npm package's manifests live under `plugins/huaweicloud-core/`.\n\nThe `mcp.json` MCP server launches via `npx -y -p huaweicloud-devkit huaweicloud-devkit-mcp`, which tracks the npm `latest` tag. During pre-release this may differ from the manifest `version`; it can be pinned after a stable release.\n\n## Prerequisites\n\n- Node.js >= 22\n\n> **China mainland users**: If you experience slow downloads or connection issues with the default npm registry, configure the Huawei Cloud npm mirror:\n>\n> ```bash\n> npm config set registry https://mirrors.huaweicloud.com/repository/npm/\n> ```\n>\n> Restore the default registry: `npm config delete registry`\n\n## Quick Start\n\n> If `--target` is omitted, the installer auto-detects agents on your machine. When multiple agents are detected, **all of them** will be installed. Specify `--target` to control which agent receives the install.\n\n```bash\nnpx --yes huaweicloud-devkit version  # print the installed plugin version per agent\nnpx --yes huaweicloud-devkit uninstall --target all --clean-global  # also remove KooCLI + OBS config\n```\n\n### OpenCode\n\n```bash\nnpx --yes huaweicloud-devkit install --target opencode\n```\n\n**Restart the session** after installation.\n\n```bash\nnpx --yes huaweicloud-devkit doctor --target opencode\nnpx --yes huaweicloud-devkit status --target opencode\nnpx --yes huaweicloud-devkit update --target opencode\nnpx --yes huaweicloud-devkit uninstall --target opencode\nrm -rf ~/.npm/_npx/  # Linux/macOS only; Windows path TBD\n```\n\n### Codex\n\n```bash\nnpx --yes huaweicloud-devkit install --target codex\n```\n\n**Restart the Codex session** after installation.\n\n```bash\nnpx --yes huaweicloud-devkit doctor --target codex\nnpx --yes huaweicloud-devkit status --target codex\nnpx --yes huaweicloud-devkit update --target codex\nnpx --yes huaweicloud-devkit uninstall --target codex\n```\n\n> **Requires Codex CLI** — the `codex` command must be in PATH. If Codex is installed via WindowsApps (Microsoft Store), use `--target codex-desktop` instead. Run `codex --version` to verify CLI availability.\n\n### CodeArts Agent\n\n```bash\nnpx --yes huaweicloud-devkit install --target codearts\n```\n\n**Restart the session** after installation.\n\n```bash\nnpx --yes huaweicloud-devkit doctor --target codearts\nnpx --yes huaweicloud-devkit status --target codearts\nnpx --yes huaweicloud-devkit update --target codearts\nnpx --yes huaweicloud-devkit uninstall --target codearts\n```\n\n> **Sandbox mode**: CodeArts defaults to sandbox mode which blocks KooCLI. `install-hcloud` detects this and shows how to resolve it — install KooCLI outside the sandbox terminal, or disable sandbox mode in CodeArts settings (Settings → Chats → Agents Terminal Command Running Mode → Auto Running).\n\n### CodeArts Work\n\n```bash\nnpx --yes huaweicloud-devkit install --target codearts-work\n```\n\n**Restart the session** after installation.\n\n```bash\nnpx --yes huaweicloud-devkit doctor --target codearts-work\nnpx --yes huaweicloud-devkit status --target codearts-work\nnpx --yes huaweicloud-devkit update --target codearts-work\nnpx --yes huaweicloud-devkit uninstall --target codearts-work\n```\n\n> **CodeArts Work** (CodeArts Space, appId: `com.codearts.work`) uses user-level config at `%USERPROFILE%\\.codeartswork\\`. No project-level `.codeartswork` directory is created.\n\n### WorkBuddy\n\n```bash\nnpx --yes huaweicloud-devkit install --target workbuddy\n```\n\n**Restart the session** after installation.\n\n```bash\nnpx --yes huaweicloud-devkit doctor --target workbuddy\nnpx --yes huaweicloud-devkit status --target workbuddy\nnpx --yes huaweicloud-devkit update --target workbuddy\nnpx --yes huaweicloud-devkit uninstall --target workbuddy\n```\n\n### DeepSeek Harness (DSH)\n\n```bash\nnpx --yes huaweicloud-devkit install --target dsh\n```\n\n**Restart the DSH session** after installation.\n\n```bash\nnpx --yes huaweicloud-devkit doctor --target dsh\nnpx --yes huaweicloud-devkit status --target dsh\nnpx --yes huaweicloud-devkit update --target dsh\nnpx --yes huaweicloud-devkit uninstall --target dsh\n```\n\n> DSH V1 reuses the existing MCP server through `@deepseek-ai/dsh-mcp-client`. If the installer reports that the client is not detected, run: `npx @deepseek-ai/dsh plugin --profile web add @deepseek-ai/dsh-mcp-client`.\n\n### OfficeAce\n\n```bash\nnpx --yes huaweicloud-devkit install --target officeace\n```\n\n**Restart OfficeAce** after installation.\n\n```bash\nnpx --yes huaweicloud-devkit doctor --target officeace\nnpx --yes huaweicloud-devkit status --target officeace\nnpx --yes huaweicloud-devkit update --target officeace\nnpx --yes huaweicloud-devkit uninstall --target officeace\n```\n\n### Hermes\n\n```bash\nnpx --yes huaweicloud-devkit install --target hermes\n```\n\n**Restart the Hermes session** after installation.\n\n```bash\nnpx --yes huaweicloud-devkit doctor --target hermes\nnpx --yes huaweicloud-devkit status --target hermes\nnpx --yes huaweicloud-devkit update --target hermes\nnpx --yes huaweicloud-devkit uninstall --target hermes\n```\n\n> **Uninstall notes**: On Linux, run `rm -rf ~/.npm/_npx/* && npm cache clean --force` after uninstall to ensure a clean slate. On Windows, close all Hermes sessions first to release file locks, then after uninstall check `%LOCALAPPDATA%\\hermes\\config.yaml` for YAML corruption and manually remove `%LOCALAPPDATA%\\hermes\\huaweicloud-plugins` if any files remain.\n> **Safety hooks**: The installer configures Hermes shell hooks (`config.yaml` → `hooks.pre_tool_call`) to intercept unsafe terminal commands such as credential file reads, environment variable dumps, and unapproved `hcloud` write operations. Hermes shows a consent prompt the first time; approve it or set `hooks_auto_accept: true` in `config.yaml` to auto-accept.\n> **MCP Python SDK**: The installer automatically installs the `mcp` Python package required by Hermes for MCP tool discovery. If you see `[FAIL] Hermes MCP Python SDK` in `doctor`, run `pip3 install mcp` manually.\n> **Windows**: See [docs/hermes-windows.md](docs/hermes-windows.md) for known issues and workarounds.\n\n### OpenClaw\n\n```bash\n# Recommended (ClawHub)\nopenclaw plugins install clawhub:huaweicloud-devkit\nopenclaw plugins uninstall huaweicloud-devkit\nopenclaw plugins update huaweicloud-devkit\n```\n\n**Restart OpenClaw** after installation. If prompted for security risk acknowledgment, add `--acknowledge-clawhub-risk`.\n\n```bash\n# Or via npx\nnpx --yes huaweicloud-devkit install --target openclaw\nnpx --yes huaweicloud-devkit status --target openclaw\nnpx --yes huaweicloud-devkit update --target openclaw\nnpx --yes huaweicloud-devkit uninstall --target openclaw\nrm -rf ~/.npm/_npx/  # Linux/macOS only; Windows path TBD\n```\n\n### AtomCode\n\n```bash\nnpx --yes huaweicloud-devkit install --target atomcode\n```\n\n**Restart the AtomCode session** after installation.\n\n```bash\nnpx --yes huaweicloud-devkit doctor --target atomcode\nnpx --yes huaweicloud-devkit status --target atomcode\nnpx --yes huaweicloud-devkit update --target atomcode\nnpx --yes huaweicloud-devkit uninstall --target atomcode\n```\n\n### Other Agents\n\nAny agent that supports MCP can use the standard config:\n\n```json\n{\n  \"mcpServers\": {\n    \"huaweicloud-devkit\": {\n      \"command\": \"npx\",\n      \"args\": [\"-y\", \"-p\", \"huaweicloud-devkit\", \"huaweicloud-devkit-mcp\"]\n    }\n  }\n}\n```\n\nNo installation required — `npx` handles everything.\n\n> Set `HW_ACCESS_KEY`/`HW_SECRET_KEY` in the MCP config `env` field for project-level credentials.\n\n### Install KooCLI\n\n```bash\nnpx --yes huaweicloud-devkit install-hcloud\n```\n\n### Configure Credentials\n\n```bash\nnpx --yes huaweicloud-devkit auth init\n```\n\nSynchronizes AK/SK to KooCLI, OBS, and sandbox APIs in one step.\n\n### Install All Agents\n\n```bash\nnpx --yes huaweicloud-devkit install --target all\n```\n\n### Update All Agents\n\n```bash\nnpx --yes huaweicloud-devkit update --target all\n```\n\n`update` is incremental — it refreshes installed files without touching your config.\n\n## What It Does\n\n- **Guided cloud operations** — agents get step-by-step guidance for 20+ Huawei Cloud services (ECS, OBS, VPC, RDS, GaussDB, FunctionGraph, APIG, CCE, and more)\n- **Safety-first execution** — all write operations require explicit user approval; credentials and secrets are automatically redacted from output\n- **Pre-execution risk checks** — public exposure, credential leaks, and destructive operations are caught before they run\n- **Regional awareness** — auto-discovers available regions and checks service availability before creating resources\n- **Sandbox (DevStation)** — temporary cloud runtime for web app deployment with instant public URL preview\n\n## Supported Services\n\nECS, OBS, VPC, IAM, RDS, GaussDB, FunctionGraph, APIG, CCE, SMN/DMS, ModelArts, Cloud Eye, CTS, DEW, Billing, CBR, WAF/AAD, DDS/DCS, Deployment, and Getting Started guides.\n\n## Documentation\n\n- [Architecture](docs/architecture.md)\n- [Safety Model](docs/safety-model.md)\n- [Hook Rule Model](docs/hook-rule-model.md)\n- [DeepSeek Harness Integration](docs/dsh-integration.md)\n- [Changelog](docs/CHANGELOG.md)\n- [KooCLI official docs](https://support.huaweicloud.com/qs-hcli/hcli_02_003.html)\n\n## Contributors\n\n<a href=\"https://github.com/huaweicloud/huaweicloud-devkit/graphs/contributors\">\n  <img src=\"https://contrib.rocks/image?repo=huaweicloud/huaweicloud-devkit\" />\n</a>\n\n## License\n\nThis project is licensed under the Apache-2.0 License. See [LICENSE](LICENSE).\n",
  "bytes": 10575,
  "sha": "7a4fa478b7b47ad6a5cd7b9206d43368628b2cd84d7612950365fa1fa01e0813",
  "repo_slug": "huaweicloud/huaweicloud-devkit",
  "fonte": "repo",
  "truncated": false,
  "api": "https://agentalog.com/api/listings/mcp_io_github_glqff_huaweicloud_devkit_77fcac85/readme"
}