Документация

Командная строка

Управляйте проектами и развёртыванием из командной строки IWE Code.

Используйте исполняемый файл IWE Code для управления проектами, настройки развёртывания и передачи файлов. Команды рабочего пространства работают без окна. Передача файлов использует сервер из профиля развёртывания.

Команды

Команды вызываются через бинарник приложения. Директории, файлы и диплинки, как и раньше, открывают рабочее пространство.

iwe open [directory]
Запустить приложение. С директорией — открыть этот проект.
iwe workspace list [--json]
Показать пространства и их проекты.
iwe workspace add-project <directory> [--space NAME] [--json]
Добавить директорию проекта в пространство. Без --space проект попадает в первое пространство.
iwe workspace remove-project <project> [--json]
Удалить проект по директории или точному имени.
iwe --help, iwe --version
Показать локализованную справку или версию.

Команды развёртывания

iwe deployment list
Вывести подключения, ключи SSH и профили.
iwe deployment connection add <name> --host HOST --username NAME [options]
Добавить подключение.
iwe deployment connection set <name> [options]
Изменить подключение.
iwe deployment connection remove <name>
Удалить неиспользуемое подключение и его секрет.
iwe deployment key add <name> <path>
Зарегистрировать файл ключа SSH.
iwe deployment key remove <name>
Удалить неиспользуемый ключ SSH и его парольную фразу.
iwe deployment profile add <name> --project DIR --connection NAME --root PATH --mapping LOCAL=REMOTE [options]
Создать профиль развёртывания хотя бы с одним сопоставлением папок.
iwe deployment profile set <name> [options]
Изменить профиль.
iwe deployment profile remove <name> [--space NAME]
Удалить профиль.
iwe deployment test <profile>
Проверить подключение профиля.
iwe deployment upload <profile> <path>
Отправить локальный файл или папку.
iwe deployment download <profile> <remote> [--overwrite]
Скачать удалённый файл или папку. Флаг --overwrite разрешает замену локальных файлов.
iwe deployment list-remote <profile> [directory]
Вывести содержимое удалённого каталога.

Параметры развёртывания

  • Команды развёртывания поддерживают --json. Флаг --help показывает параметры выбранной команды.
  • Укажите --space NAME в командах для профилей, а также в test, upload, download и list-remote.
  • Команды connection add и set принимают --protocol, --port, --auth, --key и --password-stdin. Передавайте пароль через стандартный ввод.
  • Флаги --mapping LOCAL=REMOTE и --exclude PATH можно повторять. Флаг --default false снимает статус профиля по умолчанию. В profile set флаг --clear-excluded удаляет исключения.
  • При первом подключении по SFTP проверьте отпечаток ключа сервера. Затем повторите команду с --trust-host-key FINGERPRINT. Если команда снова сообщает о неизвестном ключе, запустите её ещё раз. Она прочитает сохранённый отпечаток.

Вывод для программ

Флаг --json печатает стабильный JSON с отступом в два пробела. Ключи в snake_case совпадают с сохранённым файлом рабочего пространства.

{
  "spaces": [
    {
      "name": "Work",
      "projects": [
        {
          "name": "app",
          "directory": "/Users/name/code/app",
          "pinned": false
        }
      ]
    }
  ]
}

Коды выхода

Скрипты могут различать результат по коду выхода.

0
Команда завершилась успешно.
1
Команда завершилась ошибкой. Проверьте файл рабочего пространства, выбранный проект или профиль и результат передачи файлов.
2
Вызов некорректен: неизвестная команда или параметр, пропущено значение или open получил несуществующую директорию.

Стоит знать

  • Закройте приложение перед изменением рабочего пространства из командной строки. Оба процесса сохраняют файл без блокировок.
  • IWE_LANG или системный язык выбирает язык вывода, включая справку.
  • Неизвестные команды теперь завершаются ошибкой вместо открытия окна.

Полный справочник команд