Skip to content

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

Команда querylane даёт терминалу и скриптам те же операции, что доступны MCP-агентам: подключения, запросы к базам данных, задачи, запуски, результаты и экспорт. Она работает напрямую с файлами профиля, поэтому QueryLane не обязательно держать открытым.

Установка команды ​

  1. Откройте Настройки > CLI и MCP.
  2. Рядом с QueryLane CLI нажмите Установить CLI. QueryLane запишет небольшой скрипт запуска в ~/.local/bin/querylane, который запускает команду через Node.js, встроенный в приложение.
  3. Если ~/.local/bin нет в PATH, нажмите Добавить в PATH в строке Запуск querylane в терминале. QueryLane добавит папку в ~/.zprofile для zsh, в ~/.bash_profile для bash или в файл в ~/.config/fish/conf.d/ для fish.
  4. Откройте новое окно терминала и проверьте установку командой querylane capabilities.

Если переместить QueryLane в другую папку, в строке появится статус Нужно обновить. Нажмите Обновить CLI.

Синтаксис ​

sh
querylane <resource> <command> [ids] [--option value] [--profile main] [--json]
  • Идентификаторы указываются после команды по порядку, например querylane runs wait <runId>.
  • Параметры называются как аргументы инструмента, но в kebab-case: --file-path задаёт filePath. Можно писать --option value или --option=value. Логический параметр без значения означает true.
  • --profile <id> выбирает профиль хранения. По умолчанию используется main.
  • --file payload.json, --input-json '<json>' или --stdin передают аргументы JSON-объектом. Параметры из командной строки перекрывают его поля.
  • --timeout <секунды> задаёт время ожидания, а --step <stepId> выбирает шаг.

Каждая команда выводит JSON-конверт с полями ok, data, meta и error. По умолчанию вывод отформатирован с отступами, а --json печатает его одной строкой.

Команды ​

РесурсКоманды
capabilitiesВерсия API, области запуска и руководство по созданию задач
profileslist
connectorslist
connectionslist, get, validate, test, create, update, usage, delete, capabilities
schemasget
dbexplore, object, query, result, dispose
packageslist
jobslist, get, create, export, import, delete, revisions, validate
changespropose, show, apply, revert
stepspreview, test
runslist, get, diagnose, plan, start, wait, cancel, clear
resultssample, check
chartsrender
exportslist, start, get, wait, cancel
uilink, open
scheduleslist, а также sync, run и tick, которые использует фоновый объект

Каждая команда вызывает одноимённый MCP-инструмент, а её параметры совпадают с аргументами этого инструмента. См. Справочник MCP-инструментов. querylane call <tool_name> вызывает любой инструмент по полному имени, а querylane mcp serve запускает MCP-сервер на стандартном вводе и выводе.

Примеры ​

sh
# Найти подключение и выполнить на нём запрос
querylane connections list --query warehouse
querylane db query <connectionId> --query "SELECT count(*) FROM orders"

# Запустить задачу, подождать до двух минут и посмотреть результат
querylane jobs list --query orders
querylane runs start <jobId>
querylane runs wait <runId> --timeout 120
querylane results sample <runId> --limit 20
querylane runs diagnose <runId>

# Запустить один шаг
querylane runs start <jobId> --scope only-step --step <stepId>

# Передать задачи файлом
querylane jobs export <jobId> <jobId> --file-path orders.querylane.json
querylane jobs import orders.querylane.json --dry-run

Запуски, начатые из командной строки, продолжаются после завершения команды. Относительные пути к файлам в jobs export, jobs import и charts render отсчитываются от текущей папки.

Коды выхода ​

КодЗначение
0Успех
1Другая ошибка
2Неверные или неизвестные аргументы
3Конфликт, например изменилась ревизия
4Ошибка выполнения
5Не найдено