CodeLattice Getting Started

This guide walks through a fresh local setup without WebUI or hosted services.

Requirements

• Rust toolchain with cargo
• Git
• Bash
• python3 for smoke scripts and MCP response checks
• macOS or Linux shell environment

CodeLattice runs locally and does not upload source code.

Install from GitCode Release

The current published GitCode Release is v0.17.0-beta.2 and targets macOS Apple Silicon (darwin-arm64):

export CODELATTICE_TOOL_DIR="$HOME/.local/share/codelattice-tool"
tmp_dir="$(mktemp -d /tmp/codelattice-install-XXXXXX)"
git clone --depth 1 https://gitcode.com/aiulms/codelattice.git "$tmp_dir"
bash "$tmp_dir/scripts/install-release.sh" \
  --version v0.17.0-beta.2 \
  --install-dir "$CODELATTICE_TOOL_DIR"
"$CODELATTICE_TOOL_DIR/codelattice-mcp.sh" --self-test

The installer downloads the GitCode Release tarball, verifies the .sha256 file, installs the stable wrapper, and runs self-test. It does not write AI client configuration files.

Linux or other platforms can use the source build path until multi-platform artifacts are published.

Current master may contain newer beta-candidate features than the latest published Release. To package the current checkout, use the source packaging path below instead of install-release.sh.

Clone and Build

git clone https://gitcode.com/aiulms/codelattice.git
cd codelattice

bash scripts/install-mcp.sh --build

The primary public binary is:

target/release/codelattice

The package still also builds target/release/gitnexus-rust-core-cli as a compatibility binary.

Verify the Checkout

For a quick external-user path:

bash scripts/fresh-clone-smoke.sh --skip-tests

For a fuller local check:

cargo fmt --check
cargo test
cargo test --all-features
bash scripts/install-mcp.sh --doctor
bash scripts/codelattice-mcp.sh --self-test

Analyze a Project

Rust:

target/release/codelattice analyze \
  --root /path/to/rust/project \
  --language rust \
  --format json

Cangjie / 仓颉:

target/release/codelattice analyze \
  --root /path/to/cangjie/project \
  --language cangjie \
  --format json \
  --strict

Auto language detection:

target/release/codelattice analyze \
  --root /path/to/project \
  --language auto \
  --format json

Install MCP Runtime

AI clients should point at a stable promoted runtime instead of the development checkout:

export CODELATTICE_TOOL_DIR="$HOME/.local/share/codelattice-tool"
bash scripts/promote-to-local-tool.sh --install-dir "$CODELATTICE_TOOL_DIR"
"$CODELATTICE_TOOL_DIR/codelattice-mcp.sh" --self-test

Print client config snippets:

bash scripts/install-mcp.sh --install-dir "$CODELATTICE_TOOL_DIR" --print-config

This command only prints templates. It does not write Codex, opencode, Claude, or shell config files.

Package a Release Tarball

bash scripts/check-release-metadata.sh
bash scripts/package-release.sh
bash scripts/release-smoke.sh --tarball dist/codelattice-0.17.0-beta.2-darwin-arm64.tar.gz

The tarball contains:

• bin/codelattice
• bin/gitnexus-rust-core-cli
• codelattice-mcp.sh
• manifest.json
• CHANGELOG.md
• selected docs
• portable Rust/Cangjie/ArkTS/TypeScript/JavaScript/C/C++/Python/Shell fixtures for smoke

See release-versioning.md and release-packaging.md for release rules and artifact details.

Troubleshooting

If optional language support is missing:

bash scripts/install-mcp.sh --build

If an MCP client cannot start the wrapper, use an absolute wrapper path from:

bash scripts/install-mcp.sh --print-config

If release smoke fails, keep the temp directory for inspection:

bash scripts/release-smoke.sh --keep-temp

If release install download fails with 404, the requested release/platform artifact has not been published yet. Use the source build path or pass an available --platform.