Ця сторінка ще не перекладена українською. Показано англійську версію. Переглянути англійською

Конфігурація

RAPS підтримує кілька методів конфігурації: змінні середовища, профілі та файли .env.

Пріоритет: Прапорці CLI > Змінні середовища > Активний профіль > Значення за замовчуванням

Обов’язкові змінні середовища

APS_CLIENT_ID

Client ID вашого застосунку APS з APS Developer Portal.

# Windows PowerShell
$env:APS_CLIENT_ID = "your_client_id_here"
# macOS/Linux
export APS_CLIENT_ID="your_client_id_here"

APS_CLIENT_SECRET

Client Secret вашого застосунку APS.

# Windows PowerShell
$env:APS_CLIENT_SECRET = "your_client_secret_here"
# macOS/Linux
export APS_CLIENT_SECRET="your_client_secret_here"

Необов’язкові змінні середовища

ЗміннаОписЗа замовчуванням
APS_ACCOUNT_IDID облікового запису ACC — дозволяє використовувати команди raps admin без прапорця --account. Знайдіть у ACC Custom Integrations або через raps hub list.-
APS_CALLBACK_URLURL зворотного виклику для 3-legged OAuthhttp://localhost:8080/callback
APS_DA_NICKNAMEНікнейм Design Automation-
RAPS_TIMEOUTТайм-аут запиту в секундах120
RAPS_CONCURRENCYМаксимальна кількість паралельних операцій5
RAPS_USE_FILE_STORAGEВикористовувати файлове сховище замість системного ключовика — рекомендовано для серверів і CI/CDfalse

Використання файлу .env

Створіть файл .env у вашій робочій директорії:

APS_CLIENT_ID=your_client_id_here
APS_CLIENT_SECRET=your_client_secret_here
APS_CALLBACK_URL=http://localhost:8080/callback

# Необхідно для команд raps admin (адміністрування облікового запису ACC)
# Знайдіть в ACC → Account Admin → Custom Integrations або скопіюйте з raps hub list
APS_ACCOUNT_ID=your_account_id_here

# Рекомендовано на серверах без системного ключовика
RAPS_USE_FILE_STORAGE=true

RAPS автоматично завантажує дані з файлів .env у поточній та батьківських директоріях.

Безпека: Ніколи не додавайте файли .env до системи контролю версій. Додайте .env до .gitignore.

Управління профілями

Профілі дозволяють керувати кількома середовищами (dev, staging, production).

# Створити профіль
raps config profile create production

# Встановити значення
raps config set client_id "your_production_client_id"
raps config set client_secret "your_production_client_secret"

# Перемкнути профіль
raps config profile use production

# Переглянути всі профілі
raps config profile list

# Експорт/імпорт профілів
raps config profile export production --output ./prod-profile.json
raps config profile import ./prod-profile.json --name backup

Розташування файлів профілів

  • Windows: %APPDATA%\raps\profiles.json
  • macOS: ~/Library/Application Support/raps/profiles.json
  • Linux: ~/.config/raps/profiles.json

Фіксований контекст (нове у v4.5)

Встановлення значень контексту за замовчуванням, щоб не повторювати прапорці --account, --hub або --project у кожній команді.

# Встановити обліковий запис та проєкт за замовчуванням
raps config context set account_id abc-123
raps config context set project_id proj-456

# Показати поточний контекст
raps config context show

# Очистити весь контекст
raps config context clear

Доступні ключі:

  • hub_id — Ідентифікатор хаба за замовчуванням
  • project_id — Ідентифікатор проєкту за замовчуванням
  • account_id — Ідентифікатор облікового запису за замовчуванням

Пріоритет: явний прапорець > змінна середовища > контекст профілю > немає

Приклад робочого процесу:

# Встановити контекст одного разу
raps config context set account_id "b.acc-123"

# Тепер ці команди автоматично визначають обліковий запис
raps admin user list
raps report issues-summary
raps admin company-list

Безпечне зберігання токенів (v3.7.0+)

RAPS тепер за замовчуванням використовує безпечне сховище ключів ОС для токенів автентифікації замість текстових файлів.

# Увімкнути/вимкнути зберігання у сховищі ключів для профілю
raps config set use_keychain true   # За замовчуванням: true (безпечно)
raps config set use_keychain false  # Використовувати текстові файли (небезпечно)

# Мігрувати наявні токени до сховища ключів
raps config migrate-tokens

Розташування сховища токенів:

  • Сховище ключів (безпечне): Управляється ОС
    • Windows: Windows Credential Manager
    • macOS: macOS Keychain
    • Linux: Secret Service (gnome-keyring, kwallet)
  • Файл (небезпечне): ~/.config/raps/tokens.json (текстовий формат)

🔐 Найкраща практика безпеки: Використовуйте сховище ключів (за замовчуванням). Файлове сховище зберігає токени у відкритому вигляді і повинно використовуватись лише у захищених середовищах.

Автодоповнення оболонки

RAPS підтримує автодоповнення для bash, zsh, fish, PowerShell та elvish.

PowerShell

# Додайте до вашого профілю PowerShell ($PROFILE)
raps completions powershell | Out-String | Invoke-Expression

Bash

# Додайте до ~/.bashrc
eval "$(raps completions bash)"

Zsh

# Додайте до ~/.zshrc
eval "$(raps completions zsh)"

Fish

raps completions fish > ~/.config/fish/completions/raps.fish

Перевірка конфігурації

Переконайтеся, що все налаштовано правильно:

raps auth test

Якщо перевірка пройшла успішно — ви готові працювати з RAPS!

Наступні кроки