De CLI gebruiken

Installeer en gebruik de Stackhero CLI om uw stacks en services te beheren vanaf de commandoregel, scripts, CI en AI-agents

Introductie

De Stackhero CLI is een lichtgewicht, zelfstandig commandoregelhulpmiddel waarmee u eenvoudig uw stacks en services beheert. Hiermee kunt u services aanmaken en verwijderen, inloggegevens opvragen, configuraties bijwerken en nog veel meer, allemaal direct vanuit uw terminal. De CLI is compatibel met Linux (glibc en musl), macOS en Windows, en wordt geleverd als één enkele binary zonder afhankelijkheden, waardoor installatie en updates eenvoudig zijn.

Of u nu interactief werkt of workflows automatiseert met scripts, CI-pijplijnen of AI-agents: de Stackhero CLI is ontworpen voor zowel mensen als automatisering. Elke opdracht ondersteunt de --format=json vlag voor machineleesbare output, evenals --format=script voor het vastleggen van ruwe waarden in shell-variabelen.

Installatie

U kunt de nieuwste versie installeren door het volgende uit te voeren:

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

Deze opdracht downloadt de juiste binary voor uw platform en installeert deze als stackhero. De CLI zorgt er ook automatisch voor dat deze up-to-date blijft.

Authenticatie

U heeft twee hoofdopties voor authenticatie:

Interactief (inloggen via browser)

stackhero login

Wanneer u dit commando uitvoert, ontvangt u een URL (die ook automatisch in uw browser wordt geopend). Vanaf daar kunt u direct toegang goedkeuren vanuit uw Stackhero-dashboard, waar u al bent ingelogd. Twee-factor-authenticatie wordt volledig ondersteund en u hoeft nooit uw wachtwoord in de CLI in te voeren.

Niet-interactief (voor scripts, CI en automatisering)

Voor geautomatiseerde workflows kunt u een access token aanmaken in uw dashboard (Account > Access tokens) en deze aan de CLI doorgeven via de STACKHERO_TOKEN omgevingsvariabele.

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

Wanneer STACKHERO_TOKEN is ingesteld, heeft deze voorrang op interactieve sessies en is er dus geen browser nodig. Dit is de aanbevolen methode voor niet-interactieve toepassingen. U kunt tokens op elk moment bekijken en intrekken via uw dashboard.

Outputformaten

Elke opdracht in de CLI accepteert een globale --format optie:

• human (standaard): Produceert leesbare tabellen en tekst voor interactief gebruik.
• json: Geeft machineleesbare JSON-output, ideaal voor scripts en AI-agents.
• script: Geeft alleen ruwe waarde(n) terug, zodat u eenvoudig output aan shell-variabelen kunt toewijzen.

Bijvoorbeeld:

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

Overzicht van commando's

Als u een volledige lijst van beschikbare commando's wilt zien, voert u stackhero --help uit. Voor gedetailleerde informatie over een specifiek commando gebruikt u stackhero COMMAND --help.

Enkele veelgebruikte commando's zijn onder andere:

• 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

Voorbeeld: Een service van begin tot eind aanmaken

Hieronder vindt u een voorbeeldscript dat laat zien hoe u een stack aanmaakt, een service toevoegt, wacht tot deze gereed is en vervolgens de inloggegevens ophaalt. Dit voorbeeld is volledig niet-interactief en maakt gebruik van de STACKHERO_TOKEN omgevingsvariabele.

#!/bin/bash
set -e

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

organizationId="org-xxxxxx"
serviceStoreId="svs-xxxxxx"   # U kunt deze vinden met: stackhero services-store-list --organization-id=org-xxxxxx
instanceStoreId="ist-xxxxxx"  # U kunt deze vinden met: stackhero instances-store-list --organization-id=org-xxxxxx --service-store-id=svs-xxxxxx
regionId="europe"             # U kunt deze vinden met: stackhero regions-list

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

# Voeg een service toe
serviceId=$(stackhero --format=script service-add \
  --stack-id="${stackId}" \
  --service-store-id="${serviceStoreId}" \
  --instance-store-id="${instanceStoreId}" \
  --region-id="${regionId}")
echo "Service: ${serviceId}"

# Wacht tot de service actief is
stackhero service-wait-for --service-id="${serviceId}"

# Haal inloggegevens en configuratie op
stackhero service-configuration-get --service-id="${serviceId}" --format=json

De documentatie van elke service bevat een kant-en-klare "Automatiseren met de CLI"-gids die specifiek is voor die service, zodat u direct aan de slag kunt.

Updaten en verwijderen

De CLI houdt zichzelf automatisch up-to-date. Als u handmatig een update wilt forceren, kunt u het volgende uitvoeren:

stackhero self-update

Als u de CLI wilt verwijderen, hoeft u alleen het stackhero-bestand van uw systeem te verwijderen.