# Начните отсюда

> Установите CLI, создайте workspace и откройте свой первый документ в браузере.

Source: https://docxcelerate.com/ru/docs/start-here/

Docxcelerate нужен **Node.js 20 или новее** и больше ничего. Написание,
предпросмотр и сборка DOCX выполняются локально — не нужно заводить аккаунт и не
нужно достучаться до какой-либо службы, прежде чем вы увидите документ.

## Установите CLI

```sh
npx docxcelerate init my-documents
cd my-documents
npm run dev
```

Это весь первый запуск. Если вам удобнее иметь команду в PATH:

```sh
npm install -g docxcelerate
dxcl init my-documents
```

Или добавьте её в существующий репозиторий, где `npx dxcl` затем разрешится
локально:

```sh
npm install --save-dev docxcelerate
npx dxcl init my-documents
```

Команда — `npx docxcelerate`, а не `npx dxcl`: npx разрешает имя пакета, а
бинарник внутри называется `dxcl`.

## Создайте workspace

```sh
dxcl init my-documents
```

`dxcl init` записывает самодостаточный Vite-workspace и выполняет в нём
`npm install`. Вызванная без аргументов, команда спросит имя, шаблон и
API-эндпоинт вместо того, чтобы брать их из флагов:

```sh
dxcl init
```

| Флаг | Что делает |
| --- | --- |
| `--dir <parent-dir>` | Создаёт workspace внутри существующего каталога |
| `--sample` | Кладёт рядом рабочий документ-пример (по умолчанию) |
| `--blank` | Оставляет `documents/` пустым |
| `--api-endpoint <url>` | Направляет workspace на движок генерации |
| `--no-api-endpoint` | Настраивает без него; добавить можно позже |

Эндпоинт нужен только для документов с генерируемым текстом, и вписать его можно
в любой момент — см. [движок](/ru/docs/generation/endpoint/).

## Что получается

```text
my-documents/
  docxcelerate.config.json
  index.html
  package.json
  tsconfig.json
  vite.config.ts
  .gitignore
  preview/
    main.ts
    styles.css
  documents/
    welcome/
```

Всё, что выше `documents/`, — приложение предпросмотра. `documents/` — ваша
работа: по каталогу на документ, и с `--sample` там уже лежит `welcome/`.

`docxcelerate.config.json` хранит именованные пресеты поведения сборки и
загрузки. Всё остальное — обычный проект на Vite: откройте его в редакторе, и он
будет вести себя именно так.

## Откройте предпросмотр

```sh
npm run dev
```

Сайт предпросмотра поднимается на `127.0.0.1:4507`. Выберите документ — он будет
разрешён на своих данных предпросмотра, собран в настоящий `.docx` прямо в
браузере и прочитан обратно через `docx-preview`, так что вы смотрите на сам
файл, а не на его приближение.

Отредактируйте любой файл в `documents/` — и страница перезагрузится с
изменением на месте.

С workspace идут ещё три скрипта:

| Скрипт | Что запускает |
| --- | --- |
| `npm run document:new` | `dxcl document new` — новый документ |
| `npm run document:node` | `dxcl document node` — новый узел в нём |
| `npm run documents:check` | `tsc` по каждому документу |

## Куда дальше

- [Как писать узлы](/ru/docs/writing-nodes/) — части, из которых собирается документ
- [Проекты документов](/ru/docs/document-projects/) — файлы документа и то, что их настраивает
- [Модель узлов](/ru/docs/nodes/overview/) — каждый тип узла и предпросмотр для каждого