Skip to content

Команды управления проектами

Группа команд для управления проектами Runium.

Синтаксис:

sh
runium project <command> [options]

project list

Вывести список проектов.

Синтаксис:

sh
runium project list [options]

Опции:

  • -s, --sort - сортировать по имени

Пример:

sh
# Показать все проекты
runium project list

# Показать проекты с сортировкой
runium project list --sort

project add

Добавить новый проект в профиль.

Синтаксис:

sh
runium project add <path> [name]

Аргументы:

  • <path> - путь к файлу конфигурации проекта
  • [name] - имя проекта (по умолчанию используется ID из конфигурации проекта)

Пример:

sh
# Добавить проект с именем равным ID из конфигурации
runium project add ./runium.config.js

# Добавить проект с пользовательским именем
runium project add ./runium.config.js my-project

# Добавить проект с абсолютным путем
runium project add /home/user/projects/app/runium.config.js my-project

project remove

Удалить проект из профиля.

Синтаксис:

sh
runium project remove [options] [name...]

Аргументы:

  • [name...] - имена проектов для удаления

Опции:

  • -a, --all - удалить все проекты

Пример:

sh
# Удалить конкретный проект
runium project remove my-project

# Удалить несколько проектов
runium project remove project1 project2 project3

# Удалить все проекты
runium project remove --all

project start

Запустить проект.

Синтаксис:

sh
runium project start [options] <name>

Аргументы:

  • <name> - имя проекта или путь к файлу конфигурации (при использовании -f)

Опции:

  • -f, --file - использовать путь к файлу вместо имени проекта
  • -o, --output - выводить изменения состояния проекта
  • -w, --working-dir <choice> - установить рабочую директорию
    • cwd - текущая директория (по умолчанию)
    • project - директория проекта

Пример:

sh
# Запустить проект по имени
runium project start my-project

# Запустить проект из файла
runium project start --file ./runium.config.js

# Запустить с выводом состояния
runium project start --output my-project

# Запустить с рабочей директорией проекта
runium project start --working-dir project my-project

project stop

Остановить запущенный проект.

Синтаксис:

sh
runium project stop [options] <name>

Аргументы:

  • <name> - имя проекта или путь к файлу конфигурации (при использовании -f)

Опции:

  • -f, --file - использовать путь к файлу вместо имени проекта

Пример:

sh
# Остановить проект по имени
runium project stop my-project

# Остановить проект по файлу
runium project stop --file ./runium.config.js

project status

Показать статус проекта.

Синтаксис:

sh
runium project status [options] <name>

Аргументы:

  • <name> - имя проекта или путь к файлу конфигурации (при использовании -f)

Опции:

  • -f, --file - использовать путь к файлу вместо имени проекта
  • -t, --tasks - показать статус задач
  • -a, --all - показать всю историю изменений состояния

Пример:

sh
# Показать текущий статус проекта
runium project status my-project

# Показать статус с задачами
runium project status --tasks my-project

# Показать всю историю изменений состояния проекта
runium project status --all my-project

# Показать полную историю измениний состояния проекта и задач
runium project status --tasks --all my-project

project validate

Проверить валидность конфигурации проекта.

Синтаксис:

sh
runium project validate [options] <name>

Аргументы:

  • <name> - имя проекта или путь к файлу конфигурации (при использовании -f)

Опции:

  • -f, --file - использовать путь к файлу вместо имени проекта

Пример:

sh
# Валидировать проект по имени
runium project validate my-project

# Валидировать проект по файлу
runium project validate --file ./runium.config.js