Carbon-Now CLI 使用教程

Carbon-Now CLI 使用教程

carbon-now-cli🎨 Beautiful images of your code — from right inside your terminal.项目地址:https://gitcode.com/gh_mirrors/ca/carbon-now-cli

1. 项目的目录结构及介绍

Carbon-Now CLI 是一个用于生成代码图片的命令行工具。以下是其基本的目录结构：

carbon-now-cli/
├── bin/
│   └── carbon-now
├── src/
│   ├── cli.js
│   ├── config.js
│   ├── interactive.js
│   ├── presets.js
│   └── utils.js
├── .gitignore
├── .npmignore
├── LICENSE
├── package.json
└── README.md

目录结构介绍

• bin/: 包含可执行文件 carbon-now。
• src/: 包含主要的源代码文件。
  • cli.js: 命令行接口的主要文件。
  • config.js: 配置文件处理逻辑。
  • interactive.js: 交互模式处理逻辑。
  • presets.js: 预设处理逻辑。
  • utils.js: 工具函数。
• .gitignore: Git 忽略文件配置。
• .npmignore: NPM 忽略文件配置。
• LICENSE: 项目许可证。
• package.json: 项目依赖和脚本配置。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

项目的启动文件是 bin/carbon-now。这是一个可执行文件，用于启动 Carbon-Now CLI 工具。

启动文件内容

#!/usr/bin/env node

require('../src/cli');

这个文件使用 Node.js 环境运行 src/cli.js 文件，从而启动命令行工具。

3. 项目的配置文件介绍

Carbon-Now CLI 的配置文件主要涉及预设（presets）和本地配置（local configs）。

预设文件

预设文件通常存储在用户主目录下的 .carbon-now.json 文件中。这个文件包含了用户自定义的设置，如主题、字体、窗口控制等。

示例预设文件

{
  "presets": {
    "hacker": {
      "theme": "Dracula",
      "backgroundColor": "#000000",
      "windowControls": true,
      "fontFamily": "Fira Code",
      "lineNumbers": true
    }
  }
}

本地配置文件

本地配置文件可以通过 --config 标志指定。这些文件通常用于项目共享预设。

示例本地配置文件

{
  "presets": {
    "dark": {
      "theme": "One Dark",
      "backgroundColor": "#1e1e1e",
      "windowControls": false,
      "fontFamily": "JetBrains Mono",
      "lineNumbers": false
    }
  }
}

通过这些配置文件，用户可以自定义 Carbon-Now CLI 的行为和输出样式。

carbon-now-cli🎨 Beautiful images of your code — from right inside your terminal.项目地址:https://gitcode.com/gh_mirrors/ca/carbon-now-cli