环境准备#

安装指导#

首先请前往 仓颉官网 , 下载适配平台架构的安装包:

• cangjie-sdk-linux-x64-x.y.z.tar.gz: 适用于x86_64架构Linux系统的仓颉工具链

• cangjie-sdk-linux-aarch64-x.y.z.tar.gz: 适用于aarch64架构Linux系统的仓颉工具链

• cangjie-sdk-mac-aarch64-x.y.z.tar.gz: 适用于aarch64/arm64架构macOS系统的仓颉工具链

下载完成之后, 如果你是WSL, 那么还需要将下载好的文件移到WSL系统中:

在Windows上下载完成之后, 找到你的文件路径, 例如:"C:\Users\humid1ch\Downloads\cangjie-sdk-linux-x64-1.0.3.tar.gz"

然后启动你的WSL, 可以将工具链压缩包复制到Linux的目标路径下:

1
cp /mnt/c/Users/humid1ch/Downloads/cangjie-sdk-linux-x64-1.0.3.tar.gz .
2
# /mnt/c 对应挂载 Windows的C盘

假设这里选择了cangjie-sdk-linux-x64-x.y.z.tar.gz, 下载到本地后, 请执行如下命令解压:

1
tar xvf cangjie-sdk-linux-x64-x.y.z.tar.gz

解压完成, 可以在当前工作路径下看到一个名为cangjie的目录, 其中存放了仓颉工具链的全部内容, 请执行如下命令完成仓颉工具链的安装配置:

1
source cangjie/envsetup.sh

为了验证是否安装成功, 可以执行如下命令:

1
cjc -v

其中cjc是仓颉编译器的可执行文件名, 如果在命令行中看到了仓颉编译器版本信息, 表示已经成功安装了仓颉工具链

值得说明的是, envsetup.sh脚本只是在当前shell环境中配置了工具链相关的环境变量, 所以仓颉工具链仅在当前shell环境中可用, 在新的shell环境中, 需要重新执行envsetup.sh脚本配置环境

若想使仓颉工具链的环境变量配置在shell启动时自动生效, 可以在$HOME/.bashrc或$HOME/.zshrc(依shell种类而定)等shell初始化配置文件的最后加入以下命令:

假设仓颉安装包解压在/home/user/cangjie中

1
source /home/user/cangjie/envsetup.sh  # 即 envsetup.sh 的绝对路径

配置完成后shell启动即可直接使用仓颉编译工具链

执行命令解压仓颉工具链:

从解压命令执行过程的输出信息中, 可以看到cangjie/envsetup.sh

然后执行命令激活工具链的相关配置:

WARNING

如果你和我一样, 用的fish而不是bash或zsh, 那么envsetup.sh是没有办法直接执行的

1
# Copyright Huawei Technologies Co., Ltd. 2020-2023. All rights reserved.
2
# This script needs to be placed in the output directory of Cangjie compiler.
3
# ** NOTE: Please use`source' command to execute this script. **
4

5
# Get the absolute path of this script
6
set script_dir (dirname (status -f))
7
set script_dir (realpath "$script_dir")
8
set -gx CANGJIE_HOME "$script_dir"
9

10
# Get hardware architecture
11
set hw_arch (uname -m)
12
if test -z "$hw_arch"
13
    set hw_arch "x86_64"
14
end
15

16
# Set PATH
17
set -gx PATH "$CANGJIE_HOME/bin" "$CANGJIE_HOME/tools/bin" "$HOME/.cjpm/bin" $PATH
18

19
# Set LD_LIBRARY_PATH
20
set -gx LD_LIBRARY_PATH "$CANGJIE_HOME/runtime/lib/linux_$hw_arch"_llvm "$CANGJIE_HOME/tools/lib" $LD_LIBRARY_PATH
21

22
# Setup auto completion for cjc and cjc-frontend (Fish equivalent)
23
if command -q cjc
24
    # Remove existing completions if any
25
    complete -c cjc --erase
26

27
    # Set up generic file completion for cjc (similar to _gnu_generic in bash/zsh)
28
    complete -c cjc -f -a "(ls)" -d "Cangjie compiler command"
29
    complete -c cjc -s h -l help -d "Show help"
30
    complete -c cjc -l version -d "Show version"
31
    complete -c cjc -s v -l verbose -d "Verbose output"
32
    complete -c cjc -s o -l output -r -d "Output file"
33
end
34

35
if command -q cjc-frontend
36
    # Remove existing completions if any
37
    complete -c cjc-frontend --erase
38

39
    # Set up generic file completion for cjc-frontend
40
    complete -c cjc-frontend -f -a "(ls)" -d "Cangjie frontend command"
41
    complete -c cjc-frontend -s h -l help -d "Show help"
42
    complete -c cjc-frontend -l version -d "Show version"
43
    complete -c cjc-frontend -s v -l verbose -d "Verbose output"
44
    complete -c cjc-frontend -s o -l output -r -d "Output file"
45
end
46

47
# Clean up temporary variables
48
set -e hw_arch
49
set -e script_dir
50

51
echo "Cangjie environment set for Fish shell"
52
echo "CANGJIE_HOME = $CANGJIE_HOME"
53
echo "Auto-completion enabled for cjc and cjc-frontend"

如果你是bash或zsh或兼容bash语法的shell, source cangjie/envsetup.sh就可以了

且, 每次打开终端都需要重新执行, 或者把source envsetup.sh(绝对路径)添加到目标.bashrc或.zshrc中

然后, 执行cjc -v查看是否能够执行成功:

卸载与更新#

在Linux和macOS平台, 删除上述仓颉工具链的安装包目录, 同时移除上述环境变量(最简单的, 可以新开一个shell环境), 即可完成卸载

1
$ rm -rf <path>/<to>/cangjie

若需要更新仓颉工具链, 需要先卸载当前版本, 然后按上述指导重新安装最新版本的仓颉工具链

安装指导#

在Windows平台上, 仓颉为开发者提供了exe和zip两种格式的安装包, 请前往仓颉官网, 选择和下载适配平台架构的Windows版安装包

• 如果选择exe格式的安装包(例如cangjie-sdk-windows-x64-x.y.z.exe), 请直接执行此文件, 跟随安装向导点击操作, 即可完成安装

• 如果选择zip格式的安装包(例如cangjie-sdk-windows-x64-x.y.z.zip), 请将它解压到适当目录

  在安装包中, 仓颉为开发者提供了三种不同格式的安装脚本, 分别是envsetup.bat, envsetup.ps1和envsetup.sh, 可以根据使用习惯及环境配置, 选择一种执行:

  若使用Windows 命令提示符(CMD)环境, 请执行:

  1
  path\to\cangjie\envsetup.bat
  

  若使用PowerShell环境, 请执行:

  1
  . path\to\cangjie\envsetup.ps1
  

  若使用MSYS shell、bash等环境, 请执行:

  1
  source path/to/cangjie/envsetup.sh
  

  为了验证是否安装成功, 请在以上命令环境中继续执行cjc -v命令, 如果输出了仓颉编译器版本信息, 表示已经成功安装了仓颉工具链

值得注意的是, 基于zip安装包和执行脚本的安装方式, 类似于Linux平台, 即envsetup脚本所配置的环境变量, 只在当前命令行环境中有效, 如果打开新的命令行窗口, 需要重新执行envsetup脚本配置环境

此时, 若想使仓颉工具链的环境变量配置在命令提示符或终端启动时自动生效, 可以对系统进行如下配置:

• 若使用 bash 环境, 可以根据如下步骤操作:

  在$HOME/.bashrc初始化配置文件的最后加入以下命令($HOME为当前用户目录的路径):

  1
  # 假设仓颉安装包解压在 /home/user/cangjie 中
  2
  source /home/user/cangjie/envsetup.sh  # 即 envsetup.sh 的绝对路径
  

  配置完成后bash启动即可直接使用仓颉编译工具链

• 若使用Windows 命令提示符(CMD)、PowerShell或其他环境, 可以根据如下步骤操作:

  1. 在Windows搜索框中, 搜索 “查看高级系统设置” 并打开对应窗口;

  2. 单击 “环境变量” 按钮;

  3. 执行如下操作, 配置CANGJIE_HOME变量:

     1. 在 “用户变量”(为当前用户进行配置)或 “系统变量”(为系统所有用户进行配置)区域中, 查看是否已有CANGJIE_HOME环境变量

        若没有, 则单击 “新建” 按钮, 并在 “变量名” 字段中输入CANGJIE_HOME

        若有, 则说明该环境可能已经进行过仓颉配置, 如果想要继续为当前的仓颉版本进行配置并覆盖原配置, 请点击 “编辑” 按钮, 进入 “编辑系统变量” 窗口

     2. 在 “变量值” 字段中输入仓颉安装包的解压路径, 若原先已经存在路径, 则使用新的路径覆盖原有的路径, 例如仓颉安装包解压在D:\cangjie, 则输入D:\cangjie

     3. 配置完成后, “编辑用户变量” 或 “编辑系统变量” 窗口中显示的变量名为CANGJIE_HOME、变量值为D:\cangjie

        确认路径正确配置后单击 “确定”

  4. 执行如下操作, 配置Path变量:

     1. 在 “用户变量”(为当前用户进行配置)或 “系统变量”(为系统所有用户进行配置)区域中, 找到并选择Path变量, 单击 “编辑” 按钮, 进入 “编辑环境变量” 窗口

     2. 分别单击 “新建” 按钮, 并分别输入%CANGJIE_HOME%\bin、%CANGJIE_HOME%\tools\bin、%CANGJIE_HOME%\tools\lib、%CANGJIE_HOME%\runtime\lib\windows_x86_64_llvm(%CANGJIE_HOME%为仓颉安装包的解压路径)

        例如, 仓库安装包解压在D:\cangjie, 则新建的环境变量分别为: D:\cangjie\bin、D:\cangjie\tools\bin、D:\cangjie\tools\lib、D:\cangjie\runtime\lib\windows_x86_64_llvm

     3. (仅适用于为当前用户设置)单击 “新建” 按钮, 并输入当前用户目录路径, 并在路径后面添加.cjpm\bin

        例如用户路径在C:\Users\bob, 则输入C:\Users\bob\.cjpm\bin

     4. 配置完成后应能在 “编辑环境变量” 窗口中看到配置的路径如下所示

        确认路径正确配置后单击 “确定”

        1
        D:\cangjie\bin
        2
        D:\cangjie\tools\bin
        3
        D:\cangjie\tools\lib
        4
        D:\cangjie\runtime\lib\windows_x86_64_llvm
        5
        C:\Users\bob\.cjpm\bin
        

     5. 单击 “确定” 按钮, 退出 “环境变量” 窗口

     6. 单击 “确定” 按钮, 完成设置

     注意:

     设置完成后可能需要重启命令行窗口或重启系统以让设置生效

  配置完成后Windows 命令提示符(CMD)或PowerShell启动即可直接使用仓颉编译工具链

卸载与更新#

• 如果选择exe格式的安装包进行的安装, 运行仓颉安装目录下的unins000.exe可执行文件, 跟随卸载向导点击操作, 即可完成卸载

• 如果选择zip格式的安装包进行的安装, 删除仓颉工具链的安装包目录, 同时移除上述环境变量设置(若有), 即可完成卸载

若需要更新仓颉工具链, 需要先卸载当前版本, 然后按上述指导重新安装最新版本的仓颉工具链