Naudokite CLI

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

Įvadas

Stackhero CLI yra lengvas, autonominis komandų eilutės įrankis, padedantis valdyti jūsų stack'us ir paslaugas tiesiai iš terminalo. Jį galite naudoti paslaugoms kurti ir šalinti, prisijungimo duomenims pasiekti, konfigūracijoms atnaujinti ir daugeliui kitų kasdienių užduočių atlikti.

CLI veikia Linux (glibc ir musl), macOS ir Windows sistemose. Jis pateikiamas kaip vienas dvejetainis failas be papildomų priklausomybių, todėl diegimas ir atnaujinimai yra paprasti.

Nesvarbu, ar dirbate interaktyviai, ar automatizuojate workflows naudodami scenarijus, CI pipelines ar AI agentus, Stackhero CLI yra sukurtas tiek žmonėms, tiek automatizavimui. Kiekviena komanda palaiko --format=json parametrą, skirtą mašinai suprantamai išvesčiai, taip pat --format=script, kai norite gauti neapdorotas reikšmes į shell kintamuosius.

Diegimas

Naujausią versiją galite įdiegti paleidę:

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

Ši komanda atsisiunčia jūsų platformai tinkamą dvejetainį failą ir įdiegia jį kaip stackhero. CLI taip pat automatiškai palaiko savo naujausią versiją.

Autentifikavimas

Turite dvi pagrindines autentifikavimo parinktis:

Interaktyvus prisijungimas per naršyklę

stackhero login

Paleidus šią komandą, CLI pateikia jums URL ir taip pat automatiškai atidaro jį naršyklėje. Ten galite patvirtinti prieigą tiesiai iš savo Stackhero valdymo skydelio, kuriame jau esate prisijungę.

Dviejų veiksnių autentifikavimas yra visiškai palaikomas, ir jums nereikia įvesti savo slaptažodžio CLI aplinkoje.

Neinteraktyvus autentifikavimas scenarijams, CI ir automatizavimui

Automatizuotiems workflows galite susikurti access token savo valdymo skydelyje, skiltyje Account > Access tokens, ir perduoti jį CLI naudodami aplinkos kintamąjį STACKHERO_TOKEN.

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

Kai STACKHERO_TOKEN yra nustatytas, jis turi pirmenybę prieš interaktyvias sesijas, todėl naršyklė tampa nebūtina. Šis metodas puikiai tinka neinteraktyviems naudojimo scenarijams. Tokenus galite peržiūrėti ir atšaukti savo valdymo skydelyje bet kuriuo metu.

Išvesties formatai

Kiekviena CLI komanda priima globalią --format parinktį:

• human (numatytasis): rodo skaitomas lenteles ir tekstą interaktyviam naudojimui.
• json: grąžina mašinai suprantamą JSON, kuris naudingas scenarijams ir AI agentams.
• script: grąžina tik neapdorotą(-as) reikšmę(-es), todėl išvestį lengva priskirti shell kintamiesiems.

Pavyzdžiui:

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

Komandų apžvalga

Jei norite pamatyti visą galimų komandų sąrašą, galite paleisti stackhero --help. Jei norite išsamios informacijos apie konkrečią komandą, galite pabandyti stackhero COMMAND --help.

Kai kurios 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: sukurkite paslaugą nuo pradžios iki pabaigos

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

#!/bin/bash
set -e

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

serviceStore="directus"   # A service store name. See: `stackhero services-store-list`
instance="1GB"            # An instance (size) name. See: `stackhero instances-store-list --service-store=directus`
region="europe"           # A region name. See: `stackhero regions-list`

# Create a stack (uses your only organization, add `--organization` if you have several)
stackId=$(stackhero --format=script stack-create \
  --name="My stack")
echo "Stack: ${stackId}"

# Add a service (names are resolved automatically, and the stack ID above also works)
serviceId=$(stackhero --format=script service-add \
  --stack="My stack" \
  --service-store="${serviceStore}" \
  --instance="${instance}" \
  --region="${region}")
echo "Service: ${serviceId}"

# Wait for the service to be running
stackhero service-wait-for --service="${serviceId}"

# Retrieve credentials and configuration
stackhero service-configuration-get --service="${serviceId}" --format=json

Kiekviename paslaugos dokumentacijos puslapyje yra paruoštas naudoti Automate with the CLI vadovas, pritaikytas tai paslaugai, kad turėtumėte viską, ko reikia pradžiai.

Atnaujinimas ir pašalinimas

CLI automatiškai palaiko savo naujausią versiją. Jei kada nors norėsite priverstinai paleisti atnaujinimą rankiniu būdu, galite vykdyti:

stackhero self-update

Jei norite pašalinti CLI, galite tiesiog ištrinti stackhero dvejetainį failą iš savo sistemos.