> ## Documentation Index
> Fetch the complete documentation index at: https://docs.squarecloud.app/llms.txt
> Use this file to discover all available pages before exploring further.

# 如何创建 squarecloud.ignore 文件

> 了解如何使用 squarecloud.ignore 从 Square Cloud 部署中排除文件

## 什么是 `squarecloud.ignore` 文件？

`squarecloud.ignore` 文件用于定义上传或部署应用时需要排除的文件和文件夹。它适用于 Square Cloud 的 VS Code 扩展和 Square Cloud CLI。

它的语法与 `.gitignore` 类似，因此可以使用注释、模式、目录规则和否定规则。

## 创建文件

在项目根目录中创建名为 `squarecloud.ignore` 的文件。

```gitignore theme={null}
# 本地依赖
node_modules/

# 本地文件和机密信息
.env
.env.*

# 减小部署大小
*.log
```

<Info>文件名必须完全是 `squarecloud.ignore`</Info>

## 语法

每一行都是一条规则。匹配规则的文件或文件夹会从部署中排除。

| 模式             | 匹配内容                   |
| -------------- | ---------------------- |
| `file.txt`     | 与规则位于同一目录中、名称为此名称的文件。  |
| `/config.json` | 项目根目录中的 `config.json`。 |
| `logs/`        | 所有名为 `logs` 的目录及其内容。   |
| `*.log`        | 以 `.log` 结尾的文件。        |
| `**/cache/`    | 任意层级的 `cache` 目录。      |
| `# 注释`         | 注释，不会排除任何内容。           |

<Note>在模式中使用 `/` 作为目录分隔符，包括 Windows。</Note>

## 常见示例

排除开发工具、生成文件和本地机密信息，同时保留部署所需的生产文件：

```gitignore theme={null}
# 依赖和工具
node_modules/
.vscode/
.idea/

# 环境文件
.env
.env.local

# 生成文件
coverage/
__pycache__/
*.log

# 忽略临时文件
*.tmp
*.cache

```

## 应用方式

VS Code 扩展和 CLI 在准备上传或部署文件时会读取 `squarecloud.ignore`。匹配排除规则的文件不会包含在发送到生产环境的内容中。
请将运行时需要的文件（例如配置中由 `MAIN` 指定的文件）放在不会被排除的路径中。