Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

cjv developer guide

This guide covers cjv builds, architecture, testing, website maintenance, and releases. See the user guide for installing and using Cangjie SDKs.

Repository layout

DirectoryContents
cmd/cjv/Go entry point for cjv, cjv-init, and SDK proxy binaries
internal/CLI command groups, installation lifecycle, distribution, transactions, and runtime environment
tests/End-to-end CLI integration, installer script, and live-download smoke tests
web/React landing page, browser platform detection, and public installer scripts (install.sh, install.ps1)
docs/User and developer guides (with Chinese in src/ and English in en/) plus the shared theme
deployment/Edge functions and site verification tools for Cloudflare Worker and Tencent Cloud EdgeOne
scripts/Platform catalog generators, CI scope filter, documentation builder, and HarmonyOS test helpers

Quick workflow for contributors

  1. Start by building cjv from source and trying out your local build in an isolated CJV_HOME directory.
  2. Read the Architecture guide to find the package that owns the behavior you want to change and understand its locking, transaction, and state-isolation invariants.
  3. Run the relevant commands in Testing and checks to verify your changes across Go packages, installer scripts, the frontend, and the bilingual mdBook manuals.
  4. Follow the Contributing guide for atomic commits, commit message conventions, and pull request expectations.
  5. For maintaining the public website, documentation build, or release pipelines, see Landing page, Documentation site, and Releases.