# Directus Serve CLI

Manage directus files to serve them with directus-extension-serve.

## API

To check the complete CLI API goto [API](./docs/API.md).

### Config

All properties can be passed via a config file. We use [cosmiconfig](https://github.com/cosmiconfig/cosmiconfig) to fetch different config files:

```shell
By default, Cosmiconfig will check the current directory for the following:

- a package.json property
- a JSON or YAML, extensionless "rc file"
- an "rc file" with the extensions `.json`, `.yaml`, `.yml`, `.js`, `.ts`, `.mjs`, or `.cjs`
- any of the above two inside a `.config` subdirectory
```

## Commands

### Upload

Upload files to a Directus instance:

```bash
npx directus-serve-cli upload --directusUrl http://localhost:8055 --src ./dist --uploadFolder <your-folder-id> --directusToken <your-access-token>
```

> **NOTE:** You can provide the `directusToken` as well via `.env` file or env variable as `DIRECTUS_ACCESS_TOKEN`. This is helpful for CI/CD environments.

All cli options can be passed via a config file. For more details, check out the [API](./docs/API.md).
Here is an example of a config file:

```js
/* .config/custom-upload-config.js */
{
  "directusUrl": "http://localhost:8055",
  "src": "./dist",
  "uploadFolder": "<your-folder-id>"
}
```

```bash
npx directus-serve-cli upload --config .config/custom-upload-config.js
```

#### Directus token with upload policy

To upload files to Directus, you need to create a directusToken with the correct upload policy. This token should have permissions to upload files to the specified folder.

First you should create a new policy in Directus that allows uploading files.
You can do this by navigating to the Directus admin panel, going to the "Settings" section, and creating a new policy with the necessary permissions:

![How to create a upload policy](https://raw.githubusercontent.com/nmerget/directus-serve/main/packages/directus-serve-cli/docs/upload-policy.gif)

You can just use `All` permissions for the upload policy, but you need at least the following permissions:

- id
- title
- folder
- tags
- location
- filename_download
- type
- storage

After creating the policy, you can create a new user, apply the policy to that user, and generate a new access token for that user.

![How to add a user](https://raw.githubusercontent.com/nmerget/directus-serve/main/packages/directus-serve-cli/docs/add_user.gif)