Installera Kvarts på din dator

Det här behöver du

Git och åtkomst till det privata repot whitespace-se/malm-gateway, exempelvis genom din GitHub-anslutna SSH-nyckel.
Go enligt kravet i repots go.mod, för närvarande 1.27.1. Använd Go:s officiella installationsanvisningar om Go saknas.
En personlig API-nyckel med publiceringsbehörighet och projektets ID från ansvarig administratör.

Git och Go behövs för bygget. Den färdiga klienten kommunicerar med den befintliga Kvarts-tjänsten. Du behöver inte installera Docker, Kubernetes eller egna S3-nycklar för vanlig publicering. Bun behövs bara om du även ska köra repots TypeScript-skript.

Hämta och bygg verktyget

Kör kommandona i en katalog där du vill ha repot. Grenen dev innehåller CLI-verktyget med namnet kvarts och produktionsadressen som standard.

git clone --branch dev git@github.com:whitespace-se/malm-gateway.git
cd malm-gateway
go version
mkdir -p "$HOME/.local/bin"
go build -o "$HOME/.local/bin/kvarts" ./cmd/kvarts
export PATH="$HOME/.local/bin:$PATH"
MALM_API_KEY= kvarts --help

Har du redan repot, återanvänd det och kontrollera först gren och lokala ändringar. Byt inte gren eller ersätt filer med ändringar du behöver behålla. Själva byggkommandot körs från repots rot.

För att hitta kvarts även i en ny terminal behöver ~/.local/bin finnas i din permanenta PATH. Lägg följande rad en gång i exempelvis ~/.zshrc för zsh eller ~/.bashrc för bash, och öppna sedan en ny terminal:

export PATH="$HOME/.local/bin:$PATH"

Hjälpkommandot ovan använder en tom API-nyckel eftersom hjälpen annars kan visa den nyckel som är satt i miljön. Ingen nyckel behövs för att kontrollera installationen.

Anslut med din API-nyckel

Verktyget använder https://api.kvarts.network som standard. API-nyckeln läses fortfarande från MALM_API_KEY. Ett Rauthy-lösenord fungerar inte som API-nyckel.

Hämta din personliga nyckel via er godkända lösenordshanterare. I bash eller zsh kan du läsa in den utan att lägga själva nyckeln i ett kommando i terminalhistoriken:

read -r -s MALM_API_KEY
export MALM_API_KEY

Klistra in nyckeln efter den första raden och tryck Retur, kör sedan raden med export. Inmatningen visas inte. Variabeln gäller för den aktuella terminalen. Lägg aldrig nyckeln i en publiceringsmapp eller Git. CLI:t läser även en lokal .env om en sådan finns, så kontrollera att du inte använder gamla utvecklingsuppgifter.

Kontrollera vilka sidor du kan se, med projekt-ID:t du fått:

kvarts list --project-id DITT_PROJEKT_ID

Listan är interaktiv och körs i en vanlig terminal. 401 betyder att API-nyckeln saknas, är ogiltig eller har gått ut. 403 betyder att nyckeln inte ger den åtkomst som begärts.

Publicera och uppdatera en sida

Välj ett ledigt webbplatsnamn och byt ut projekt-ID:t och mappsökvägen. Mappen ska innehålla en färdig webbplats med index.html i roten. De här kommandona publicerar en öppen sida:

kvarts create min-demo --project-id DITT_PROJEKT_ID --non-interactive
kvarts deploy ./dist --name min-demo --non-interactive

Adressen blir https://min-demo.kvarts.network/. Kör samma deploy-kommando för att uppdatera sidan. --non-interactive passar även när en kodassistent kör kommandot. Om create misslyckas efter en nätverksstörning, återanvänd dess utskrivna --request-id enligt felmeddelandet.

Ska innehållet kräva inloggning, ordna åtkomstregler och konton före publicering. Följ instruktionerna för skyddade sidor tillsammans med projektets ansvariga.

Uppdatera din installation

Från en ren arbetskopia på dev kan du hämta nästa version och bygga om. Kontrollera först att du inte har lokala ändringar som behöver sparas:

git status --short
git pull --ff-only origin dev
go build -o "$HOME/.local/bin/kvarts" ./cmd/kvarts
MALM_API_KEY= kvarts --help

Om cmd/kvarts saknas, kontrollera att du har rätt gren. Om kommandot inte hittas, prova "$HOME/.local/bin/kvarts" och kontrollera din PATH.