> ## 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.

# Gerenciando arquivos

> Navegue, leia, crie, mova e exclua arquivos dentro da sua aplicação através do FilesModule.

Todos os métodos desta página estão em `app.files`:

```typescript theme={null}
const app = await api.applications.fetch("abc123def456abc123def456");
app.files; // FilesModule
```

## Listando arquivos de um diretório

`app.files.list(path?)` retorna as entradas de um diretório. O caminho padrão é `"/"`.

```typescript theme={null}
const entries = await app.files.list("/");
console.log(entries);
// [
//   { type: "file",      name: "index.js", size: 123, lastModified: 1717084800000 },
//   { type: "directory", name: "src",      size: 0,   lastModified: 1717084800000 },
// ]
```

## Lendo um arquivo

`app.files.read(path)` retorna um `Buffer` do Node.js com o conteúdo do arquivo, ou `undefined` quando o arquivo não existe.

```typescript theme={null}
const buffer = await app.files.read("/index.js");
console.log(buffer?.toString("utf8"));
```

## Criando ou sobrescrevendo um arquivo

`app.files.create(file, fileName, path?)` cria um arquivo em `path/fileName`. O caminho padrão é `"/"`.

| Parâmetro  | Tipo               | Descrição                                                        |
| ---------- | ------------------ | ---------------------------------------------------------------- |
| `file`     | `string \| Buffer` | Caminho local do arquivo ou conteúdo como `Buffer`               |
| `fileName` | `string`           | Nome do arquivo com extensão (ex.: `"version.ts"`)               |
| `path`     | `string`           | Caminho absoluto do diretório dentro da aplicação (padrão `"/"`) |

<Tabs>
  <Tab title="A partir de Buffer">
    ```typescript theme={null}
    const content = Buffer.from("export default 1\n");
    await app.files.create(content, "version.ts", "/src");
    ```
  </Tab>

  <Tab title="A partir de caminho local">
    ```typescript theme={null}
    import { join } from "node:path";

    const localPath = join(__dirname, "version.ts");
    await app.files.create(localPath, "version.ts", "/src");
    ```
  </Tab>
</Tabs>

<Warning>
  A assinatura mudou na v4. Versões anteriores aceitavam `create(content, fullPath)` — a v4 exige `create(content, fileName, path)`.
</Warning>

## Movendo ou renomeando um arquivo

`app.files.move(path, newPath)` move ou renomeia um arquivo ou diretório.

```typescript theme={null}
await app.files.move("/version.ts", "/src/version.ts");
```

## Excluindo um arquivo ou diretório

`app.files.delete(path)` apaga um arquivo ou um diretório inteiro.

```typescript theme={null}
await app.files.delete("/src/version.ts");
```