跳到主要内容

code-server 使用说明

命令格式​

Usage: code-server [options] [path]
  • 打开目录：code-server ./path/to/your/project
  • 打开已保存的工作区：code-server ./path/to/your/project.code-workspace

选项说明​

  • --auth：

    • 说明：要使用的认证类型。可选值为 [password, none]。
    • 中文翻译：用于指定所采用的身份验证类型，可选择“密码”验证或者“无”验证。

  • --password：

    • 说明：用于密码验证的密码（只能通过 $PASSWORD 环境变量或配置文件传入）。
    • 中文翻译：针对采用密码验证方式时所需的密码，该密码仅能通过 $PASSWORD 环境变量或者配置文件来进行传入操作。

  • --hashed-password：

    • 说明：针对密码验证，经过 argon2 哈希处理后的密码（只能通过 $HASHED_PASSWORD 环境变量或配置文件传入），其优先级高于 --password。
    • 中文翻译：在进行密码验证时，使用 argon2 算法进行哈希处理后的密码，该密码仅能通过 $HASHED_PASSWORD 环境变量或者配置文件来传入，并且它相较于 --password 选项具有更高的优先级。

  • --cert：

    • 说明：证书路径。如果未提供证书，则会生成一个自签名证书。
    • 中文翻译：指向证书所在的路径。若没有提供相应证书，系统将会自动生成一个自签名证书。

  • --cert-host：

    • 说明：生成自签名证书时要使用的主机名。
    • 中文翻译：在生成自签名证书过程中需要使用到的主机名称。

  • --cert-key：

    • 说明：使用非生成的证书时，证书密钥的路径。
    • 中文翻译：当使用并非系统自动生成的证书时，对应的证书密钥所在的路径信息。

  • --disable-telemetry：

    • 说明：禁用遥测功能。
    • 中文翻译：关闭遥测相关功能，使其不再收集和发送相关数据信息。

  • --disable-update-check：

    • 说明：禁用更新检查。若不添加此标志，code-server 会每隔 6 小时对照最新的 GitHub 版本进行检查，并每周通知一次有新版本可用。
    • 中文翻译：禁止进行版本更新检查操作。若未使用该标识，code-server 软件将会每间隔 6 个小时去比对查看是否有最新的 GitHub 发布版本，并会每周提醒一次有新的版本可供更新使用。

  • --disable-file-downloads：

    • 说明：禁用从 Code 进行文件下载的功能。也可以通过将 CS_DISABLE_FILE_DOWNLOADS 设置为 'true' 或 '1' 来实现同样效果。
    • 中文翻译：禁止从 Code 平台执行文件下载的操作。另外，还可以通过将环境变量 CS_DISABLE_FILE_DOWNLOADS 的值设置为 'true' 或者 '1' 来达成同样的禁用下载文件的目的。

  • --disable-file-uploads：

    • 说明：禁用文件上传功能。
    • 中文翻译：禁止进行文件上传的相关操作，使其无法向指定位置上传文件。

  • --disable-workspace-trust：

    • 说明：禁用工作区信任功能。此开关仅影响当前会话。
    • 中文翻译：关闭工作区信任特性，需要注意的是该设置仅对当前正在进行的会话产生影响，不会影响其他会话。

  • --disable-getting-started-override：

    • 说明：禁用 Help: Getting Started（帮助：入门）页面中的 coder/coder 覆盖功能。
    • 中文翻译：禁止在“帮助：入门”页面里的 coder/coder 覆盖相关功能，使其不再生效。

  • --disable-proxy：

    • 说明：禁用域名和路径代理路由。
    • 中文翻译：停用域名以及路径代理相关的路由设置，使其无法进行相应的代理操作。

  • -h, --help：

    • 说明：显示此帮助信息。
    • 中文翻译：展示当前这些帮助说明的输出内容，便于查看各项参数的使用方法和功能解释等信息。

  • --locale：

    • 说明：设置 VS Code 显示语言以及登录页面显示的语言，更多信息请参阅 https://en.wikipedia.org/wiki/IETF_language_tag。
    • 中文翻译：用于设定 VS Code 的显示语言以及在登录页面所展示的语言内容，更多的详细信息可以通过访问 https://en.wikipedia.org/wiki/IETF_language_tag 链接来了解。

  • --open：

    • 说明：在启动时在浏览器中打开。远程操作时不起作用。
    • 中文翻译：在启动 code-server 程序时，会自动在浏览器中打开相关页面，但此功能在远程操作场景下无法正常使用。

  • --bind-addr：

    • 说明：要绑定的主机:端口地址。也可以使用 $PORT 来覆盖端口。
    • 中文翻译：指定需要绑定的主机与端口对应的地址信息，此外，还可以利用 $PORT 环境变量来对端口部分进行覆盖设置。

  • --config：

    • 说明：yaml 配置文件的路径。每个标志都直接对应配置文件中的一个键。
    • 中文翻译：指向 yaml 格式配置文件所在的路径，其中每一个命令行参数选项都直接和配置文件里的一个键相对应。

  • --socket：

    • 说明：指向套接字的路径（将忽略 bind-addr）。
    • 中文翻译：用于指定套接字所在的路径，在此情况下，bind-addr 参数将会被忽略而不生效。

  • --socket-mode：

    • 说明：套接字的文件模式。
    • 中文翻译：针对套接字所设置的文件模式相关属性内容。

  • --trusted-origins：

    • 说明：针对受信任的来源禁用验证来源检查。如果无法访问反向代理配置，此选项会很有用。
    • 中文翻译：对于那些受信任的来源，禁用对其来源进行验证检查的操作。当无法访问反向代理配置时，使用该选项将会比较有帮助。

  • -v, --version：

    • 说明：显示版本信息。
    • 中文翻译：展示当前 code-server 软件的版本相关信息内容。

  • --user-data-dir：

    • 说明：指向用户数据目录的路径。
    • 中文翻译：表示用户数据所在目录的具体路径位置。

  • --extensions-dir：

    • 说明：指向扩展目录的路径。
    • 中文翻译：用于明确扩展目录所处的具体路径信息。

  • --list-extensions：

    • 说明：列出已安装的 VS Code 扩展。
    • 中文翻译：将已经安装好的 VS Code 扩展程序进行罗列展示出来。

  • --force：

    • 说明：安装 VS Code 扩展时避免提示。
    • 中文翻译：在安装 VS Code 扩展程序的过程中，避免出现相关提示信息，直接进行安装操作。

  • --install-extension：

    • 说明：通过标识符或 vsix 文件安装或更新 VS Code 扩展。扩展的标识符格式为 ${publisher}.${name}。要安装特定版本，请提供 @${version}。例如：vscode.csharp@1.2.3。
    • 中文翻译：可以通过扩展的唯一标识符或者 vsix 格式文件来对 VS Code 扩展进行安装或者更新操作。扩展的标识符格式遵循 ${publisher}.${name} 这样的规则，若要安装指定版本的扩展，则需要按照 @${version} 的格式来提供信息，例如 vscode.csharp@1.2.3 这种形式。

  • --enable-proposed-api：

    • 说明：为扩展启用提议的 API 功能。可以接收一个或多个扩展 ID 来单独启用。
    • 中文翻译：针对扩展程序启用那些处于提议阶段的 API 相关功能，并且可以接收一个或者多个扩展的 ID 信息，从而实现对相应扩展单独启用这些功能的操作。

  • --uninstall-extension：

    • 说明：通过标识符卸载 VS Code 扩展。
    • 中文翻译：依据扩展的标识符来卸载对应的 VS Code 扩展程序。

  • --show-versions：

    • 说明：显示 VS Code 扩展版本。
    • 中文翻译：将 VS Code 扩展程序的版本信息进行展示呈现出来。

  • --github-auth：

    • 说明：GitHub 认证令牌（只能通过 $GITHUB_TOKEN 环境变量或配置文件传入）。
    • 中文翻译：用于 GitHub 认证的令牌信息，该令牌仅能通过 $GITHUB_TOKEN 环境变量或者配置文件来进行传入操作。

  • --proxy-domain：

    • 说明：用于代理端口的域名。
    • 中文翻译：在进行端口代理操作时所使用到的域名相关信息。

  • -e, --ignore-last-opened：

    • 说明：忽略上次打开的目录或工作区，改为打开一个空白窗口。
    • 中文翻译：忽视上一次所打开的目录或者工作区相关信息，转而开启一个空白的窗口界面。

  • -n, --new-window：

    • 说明：强制打开一个新窗口。
    • 中文翻译：强制要求打开一个全新的窗口界面。

  • -r, --reuse-window：

    • 说明：强制在已打开的窗口中打开文件或文件夹。
    • 中文翻译：强制将文件或者文件夹在已经打开的窗口中进行打开操作，而不是新开窗口。

  • -vvv, --verbose：

    • 说明：启用详细日志记录。
    • 中文翻译：开启详细的日志记录功能，便于记录更多详细的操作相关信息。

  • -an, --app-name：

    • 说明：用于品牌展示的名称。将显示在标题栏和欢迎消息中。
    • 中文翻译：作为在品牌展示方面所使用的名称，该名称会在标题栏以及欢迎消息等位置进行显示呈现出来。

  • -w, --welcome-text：

    • 说明：登录页面上显示的文本。
    • 中文翻译：在登录页面上需要展示出来的文本内容信息。

  • --abs-proxy-base-path：

    • 说明：要添加到所有 absproxy 请求前缀的基本路径。
    • 中文翻译：针对所有 absproxy 请求需要添加到其前缀部分的基础路径相关信息。

示例服务配置​

echo "[Unit]
Description=code-server service
Documentation=
After = network-online.target

[Service]
Type=simple
Restart=always
User=root
WorkingDirectory=/etc/code-server/
ExecStart=/etc/code-server/bin/code-server --disable-update-check --config /etc/code-server/config/config.yaml --extensions-dir=/etc/code-server/extensions/  --locale zh-cn --user-data-dir=/etc/code-server/usrdata/ --disable-telemetry --enable-proposed-api all
RestartSec=1
StandardOutput=append:/etc/code-server/log/code-server.log
StandardError=append:/etc/code-server/log/code-server-err.log

[Install]
WantedBy=multi-user.target" > /etc/systemd/system/code-server.service

systemctl daemon-reload
systemctl enable code-server
systemctl restart code-server