Skip to content

Latest commit

 

History

History
86 lines (55 loc) · 7.18 KB

README_RU.md

File metadata and controls

86 lines (55 loc) · 7.18 KB
Raw

English description | Описание на русском

TARS-CLI

NPM version Downloads Mac/Linux Build Status Windows Build status Gitter

TARS-CLI — Command Line Interface для сборщика верстки TARS.

Основная проблема при разработке верстки с помощью TARS — необходимость каждый раз устанавливать все npm-зависимости. Каждый проект в результате занимает больше 200 МБ. Чтобы упростить процедуру инициализации проекта и облегчить работу с TARS в целом был создан TARS-CLI. Вся основная документация по TARS находится в оригинальном репозитории TARS.

TARS-CLI — это только интерфейс к основному сборщику, который позволяет:

  • Инициализировать проект.
  • Запустить dev-сборку с перезагрузкой браузера и открытием туннеля во внешний веб.
  • Запустить build-сборку с минифицированными файлами или в режиме release.
  • Добавить компонент с различным набором файлов.
  • Добавить страницу, как пустую, так и копию существующей.

Если у вас возникли проблемы при работе с TARS-CLI, прошу ознакомится с разделом troubleshooting.

Установка

Для корректной работы необходимо установить TARS-CLI глобально:

npm i -g tars-cli

Возможно потребуются права суперюзера. Но желательно настроить систему так, чтобы этого не требовалось.

Если вы используете Node.js версии 5.x.x, убедитесь, что вы используете npm версии 3.3.10 и выше. В противном случае обновите npm:

npm i -g npm

Пользователям Windows необходимо выполнить еще пару шагов:

  • перейти в C:\Program Files (x86)\nodejs или C:\Program Files\nodejs в cmd.exe или в любом другом терминале. Путь зависит от того, куда Node.js был установлен;
  • запустите команду npm install npm@latest.

Возможно потребуются права суперюзера.

Начните свой проект с помощью:

tars init

Команды TARS-CLI

Все команды запускаются по шаблону:

tars + command-name + flags

В любой момент можно запустить tars --help или tars -h или просто tars, без дополнительных комманд и флагов. Данная команда выведет информацию о всех доступных командах. Также можно добавить ключ --help или -h к любой команде, чтобы получить наиболее полное описание команды.

tars -v или tars --version выведет текущую установленную версию TARS-CLI и версию TARS в текущем проекте. Также будет выведена информация по обновлению, если оно доступно.

Практически во всех командах доступен интерактивный режим. В данном режиме вы сможете взаимодействовать с CLI через подобие графического интерфейса. При использовании интерактивного режима вам не нужно знать, какие флаги за что отвечают, так как вы общаетесь с CLI на естественном языке. Интерактивный режим легко отключить, если вам необходимо проводить автоматическое тестирование или что-то еще, что не требует присутствие человека.

Command list

  • tars init — инициализирует TARS.
  • tars dev — запускает dev-режим сборки.
  • tars build — запускает build-режим сборки.
  • tars start — запускает любой gulp-таск из локального gulpfile.
  • tars add-component — добавляет компонент в markup/components.
  • tars add-page — добавляет страницу в markup/pages.
  • tars update — обновляет TARS-CLI.
  • tars update-project — обновляет TARS В текущем проекте.

По любым вопросам можно обращаться по почте tars.builder@gmail.com или в gitter