Skip to main content

Set Up AstroPulse

This guide gets your workstation ready to use AstroPulse from the CLI.

Prerequisites

Step 1: Install astroctl

macOS (Homebrew):

brew tap astropulseinc/astroctl
brew install astroctl

macOS / Linux (one-line installer):

curl -fsSL https://astropulse.io/install.sh | bash

Verify:

astroctl --version

If commands like astroctl infra, astroctl cloud, or astroctl app are missing, update first:

astroctl update

Step 2: Authenticate

astroctl auth login

This opens the browser login flow, creates a default organization if you don't have one, and stores credentials under ~/.config/astropulse/config.yaml.

If you already belong to an organization, log in for the one you want:

astroctl auth login --org-id <org-id>

API key alternative: If you prefer non-interactive auth (CI/CD, scripts), create an API key in the Console under Settings > API Keys, then:

export ASTROPULSE_API_KEY=<your-api-key>

With ASTROPULSE_API_KEY set, astroctl uses that key and skips the browser flow.

Step 3: Verify

astroctl whoami

You should see your email, organization name, and active API key. If the organization is wrong, switch it:

astroctl organization use <org-name-or-id>

Next Step

Continue with Deploy a Kubernetes Cluster to provision your first cluster.