Інтерактивна оболонка

RAPS🌼RAPSRust CLI for Autodesk Platform Services.View in glossary включає потужну інтерактивну оболонку з розширеними можливостями: автодоповненням TAB, підказками параметрів та історією команд.

Запуск оболонки

raps shell

Ви побачите привітальне повідомлення з порадами щодо використання:

Welcome to the RAPS interactive shell!
Type 'help' for a list of commands, 'exit' to quit.
Use TAB for command completion, hints show required parameters.

raps>

Ключові можливості

🔥 Автодоповнення TAB

Натисніть TAB для автодоповнення команд, підкоманд та прапорців:

raps> bu[TAB]
bucket               Bucket operations (OSS)

raps> bucket cr[TAB]
create               Create a new bucket

raps> bucket create --[TAB]
--retention <transient|temporary|persistent>   --force

Розумне автодоповнення включає:

• Команди: auth, bucket, object, translate тощо
• Підкоманди: Контекстно-залежні на основі поточної команди
• Прапорці: Показує доступні опції з описами
• Типи параметрів: Відображає очікувані формати значень

Підказки параметрів

Сірий текст підказок показує обов’язкові параметри під час введення:

raps> bucket create <BUCKET_KEY>
                    ↑ сіра підказка

raps> bucket create my-bucket [--retention <transient|temporary|persistent>]
                              ↑ показані необов'язкові прапорці

raps> object upload <BUCKET_KEY> <FILE_PATH>
                    ↑ показано кілька обов'язкових параметрів

raps> translate start <URN> [--format <svf|svf2>]
                      ↑ обов'язковий  ↑ необов'язковий

Поведінка підказок:

• Обов’язкові параметри: Показані у <кутових_дужках>
• Необов’язкові прапорці: Показані у [квадратних_дужках]
• Кілька варіантів: Показані як <варіант1|варіант2|варіант3>
• Динамічне оновлення: Підказки змінюються при додаванні параметрів

Історія команд

Навігація по попередніх командах:

• Стрілка вгору: Попередня команда
• Стрілка вниз: Наступна команда
• Ctrl+R: Пошук в історії команд
• Автозбереження: Історія зберігається між сесіями

Покращений досвід роботи

# Кольоровий запрошення
raps> auth status

# Вбудована команда довідки
raps> help
Available commands:
  auth             Authentication (login, logout, status, test, whoami)
  bucket           Bucket operations (list, create, get, delete)
  object           Object operations (list, upload, download, delete)
  translate        Model Derivative (start, status, manifest, metadata)
  ...

Tips:
  • Press TAB for command completion
  • Gray text hints show required parameters
  • Use <command> --help or <command> -h for command help

Приклади використання

Інтерактивний потік автентифікації

raps> auth status
❌ Not authenticated

raps> auth login --3lo
🔐 Opening browser for 3-legged OAuth authentication...
✓ Authentication successful!

raps> auth whoami
User: john.doe@company.com

Операції з бакетами та об’єктами

# Створення бакета з підказками
raps> bucket create <BUCKET_KEY>
raps> bucket create my-project-files

# Завантаження з автодоповненням
raps> object upload my-project-files ./model.rvt
Uploading model.rvt...
████████████████████████████████████████ 100%
✓ Upload complete!

# Отримання URN для трансляції
raps> object urn my-project-files model.rvt
URN: dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6...

Робочий процес трансляції моделей

# Запуск трансляції з підказками формату
raps> translate start <URN>
raps> translate start dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6... --format svf2

# Перевірка статусу
raps> translate status dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6...
Status: success
Progress: 100%

Клавіатурні скорочення

Команди оболонки

Спеціальні команди, доступні в інтерактивному режимі:

# Показати огляд команд
raps> help

# Звичайні команди RAPS працюють як завжди
raps> bucket list
raps> auth test
raps> object upload my-bucket file.dwg

# Вихід з оболонки
raps> exit
# або
raps> quit

Корисні поради

1. Використовуйте підказки для навчання

Підказки параметрів ідеально підходять для вивчення синтаксису команд:

raps> webhook create <SYSTEM> <EVENT> <CALLBACK_URL>
# Показує, які саме параметри потрібні

2. Перебирайте варіанти через TAB

Використовуйте TAB для дослідження доступних підкоманд:

raps> auth [TAB]
login    logout   status   test     whoami   inspect-token

3. Поєднуйте з довідкою по командах

Використовуйте автодоповнення для пошуку команд, а потім отримайте детальну довідку:

raps> translate [TAB]  # Перегляд доступних підкоманд
raps> translate start --help  # Детальна довідка

4. Інтеграція зі скриптами

Тестуйте команди інтерактивно, а потім копіюйте у скрипти:

raps> bucket create my-bucket --retention persistent
# Працює чудово, тепер додайте до скрипта:
# #!/bin/bash
# raps bucket create my-bucket --retention persistent

Вирішення проблем

Автодоповнення TAB не працює

Якщо автодоповнення TAB не працює:

1. Перевірте термінал: Переконайтеся, що ваш термінал підтримує readline
2. Оновіть RAPS: Переконайтеся, що ви використовуєте v5.1.0 або новішу версію
3. Налаштування терміналу: Деякі термінали можуть заважати обробці TAB

Підказки не відображаються

Сірі підказки параметрів повинні з’являтися автоматично. Якщо ні:

1. Підтримка кольорів: Переконайтеся, що ваш термінал підтримує кольори ANSI
2. Налаштування оболонки: Перевірте, чи підказки не перекриваються налаштуваннями терміналу

Проблеми з історією

Історія команд зберігається у файлі .raps_history у вашій поточній директорії:

# Перевірити файл історії
ls -la .raps_history

# Очистити історію за потреби
rm .raps_history

Пов’язана документація

• Конфігурація — налаштування RAPS
• Автентифікація — команди та потоки автентифікації
• Команди бакетів — операції з OSS📦OSSAPS cloud storage for files and models.View in glossary-бакетами
• Команди об’єктів — завантаження та вивантаження файлів