Naudokite CLI

Įdiekite ir naudokite Stackhero CLI, kad valdytumėte savo stack'us ir paslaugas iš komandinės eilutės, skriptų, CI ir AI agentų

Įvadas

Stackhero CLI yra lengvas, savarankiškas komandinės eilutės įrankis, skirtas paprastai valdyti jūsų stack'us ir paslaugas. Su juo galite kurti ir šalinti paslaugas, gauti prisijungimo duomenis, atnaujinti konfigūracijas ir atlikti daug kitų veiksmų tiesiai iš savo terminalo. CLI suderinamas su Linux (glibc ir musl), macOS ir Windows, pateikiamas kaip vienas binarinis failas be papildomų priklausomybių, todėl diegimas ir atnaujinimas yra paprastas.

Nesvarbu, ar dirbate interaktyviai, ar automatizuojate procesus naudodami skriptus, CI pipeline'us ar AI agentus, Stackhero CLI sukurtas tiek žmonėms, tiek automatizavimui. Kiekviena komanda palaiko --format=json flag'ą mašinai skaitomam išvedimui, taip pat --format=script – žalių reikšmių priskyrimui shell kintamiesiems.

Diegimas

Naujausią versiją galite įdiegti paleisdami:

curl -fsSL https://www.stackhero.io/install.sh | sh

Ši komanda atsisiunčia tinkamą binarinį failą jūsų platformai ir įdiegia jį kaip stackhero. CLI taip pat automatiškai pasirūpina savo atnaujinimais.

Autentifikacija

Yra du pagrindiniai autentifikacijos būdai:

Interaktyvus (prisijungimas per naršyklę)

stackhero login

Paleidus šią komandą, gausite URL (kuris taip pat automatiškai atsidarys jūsų naršyklėje). Iš ten galėsite patvirtinti prieigą tiesiai iš savo Stackhero valdymo skydelio, kuriame jau esate prisijungę. Pilnai palaikomas dviejų faktorių autentifikavimas, ir jums niekada nereikės įvesti slaptažodžio į CLI.

Neinteraktyvus (skirtas skriptams, CI ir automatizavimui)

Automatizuotoms užduotims galite sukurti prieigos token'ą savo valdymo skydelyje (Account > Access tokens) ir perduoti jį CLI per STACKHERO_TOKEN aplinkos kintamąjį.

export STACKHERO_TOKEN="usr-xxxxxx:your-token"
stackhero organizations-list

Kai nustatytas STACKHERO_TOKEN, jis turi prioritetą prieš interaktyvias sesijas, todėl naršyklės nereikia. Tai rekomenduojamas būdas neinteraktyviam naudojimui. Token'us galite peržiūrėti ir atšaukti bet kada savo valdymo skydelyje.

Išvedimo formatai

Kiekviena CLI komanda priima globalų --format parametrą:

• human (numatytasis): Sugeneruoja lengvai skaitomas lenteles ir tekstą interaktyviam naudojimui.
• json: Išveda mašinai skaitomą JSON, idealiai tinka skriptams ir AI agentams.
• script: Grąžina tik žalią(-ias) reikšmę(-es), todėl lengva priskirti išvedimą shell kintamiesiems.

Pavyzdžiui:

stackhero organizations-list --format=json
stackId=$(stackhero --format=script stack-create --organization-id=org-xxxxxx --name="My stack")

Komandų apžvalga

Norėdami gauti visą galimų komandų sąrašą, paleiskite stackhero --help. Išsamesnei informacijai apie konkrečią komandą naudokite stackhero KOMANDA --help.

Dažniausiai naudojamos komandos:

• Organizations: organizations-list
• Stacks: stacks-list, stack-create, stack-rename, stack-delete
• Services: services-list, service-add, service-wait-for, service-rename, service-delete
• Configuration: service-configuration-get, service-configuration-set, service-configuration-example
• Store: services-store-list, instances-store-list, regions-list
• Upgrades: service-upgrade-instances-store-list, service-upgrade-instance
• Account: login, logout
• Maintenance: self-update

Pavyzdys: Paslaugos sukūrimas nuo pradžios iki galo

Žemiau pateiktas pavyzdinis skriptas parodo, kaip sukurti stack'ą, pridėti paslaugą, palaukti kol ji bus paruošta ir gauti jos prisijungimo duomenis. Šis pavyzdys yra visiškai neinteraktyvus ir naudoja STACKHERO_TOKEN aplinkos kintamąjį.

#!/bin/bash
set -e

export STACKHERO_TOKEN="usr-xxxxxx:your-token"

organizationId="org-xxxxxx"
serviceStoreId="svs-xxxxxx"   # Galite rasti su: stackhero services-store-list --organization-id=org-xxxxxx
instanceStoreId="ist-xxxxxx"  # Galite rasti su: stackhero instances-store-list --organization-id=org-xxxxxx --service-store-id=svs-xxxxxx
regionId="europe"             # Galite rasti su: stackhero regions-list

# Sukurti stack'ą
stackId=$(stackhero --format=script stack-create \
  --organization-id="${organizationId}" \
  --name="My stack")
echo "Stack: ${stackId}"

# Pridėti paslaugą
serviceId=$(stackhero --format=script service-add \
  --stack-id="${stackId}" \
  --service-store-id="${serviceStoreId}" \
  --instance-store-id="${instanceStoreId}" \
  --region-id="${regionId}")
echo "Service: ${serviceId}"

# Palaukti, kol paslauga bus paleista
stackhero service-wait-for --service-id="${serviceId}"

# Gauti prisijungimo duomenis ir konfigūraciją
stackhero service-configuration-get --service-id="${serviceId}" --format=json

Kiekvienos paslaugos dokumentacijoje rasite paruoštą „Automatizuoti su CLI“ gidą, pritaikytą būtent tai paslaugai, tad turėsite viską, ko reikia pradžiai.

Atnaujinimas ir pašalinimas

CLI save atnaujina automatiškai. Jei norite priverstinai atnaujinti rankiniu būdu, galite paleisti:

stackhero self-update

Jei norite pašalinti CLI, tiesiog ištrinkite stackhero binarinį failą iš savo sistemos.