Skip to main content

Set Up AstroPulse

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

If You Want the Shortest Path​

Open Nova and ask for the outcome you want:

  • Browser: Open Nova →
  • Console route: /nova
  • Terminal: astroctl nova

Example prompts:

Help me connect my AWS account and create my first EKS cluster.
I have a Kubernetes cluster already. Help me register it with AstroPulse.

Nova can walk you through setup, explain what each step does, and help produce the YAML or CLI commands you need.

Prerequisites​

Before you start, make sure you have:

  • A macOS or Linux shell for the one-line installer, or Homebrew on macOS.
  • Access to the AstroPulse Console.
  • Access to the cloud account or Kubernetes cluster you plan to connect later.
  • kubectl installed if you want to inspect deployed workloads directly.

Install astroctl​

Install astroctl with the one-line installer:

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

Or install with Homebrew on macOS:

brew tap astropulseinc/astroctl
brew install astroctl

Verify the CLI:

astroctl --version

If your local help does not show commands such as astroctl infra, astroctl cloud, astroctl app, or astroctl nova, update the CLI before continuing:

astroctl update

Keep the CLI current:

astroctl update

Authenticate​

You can authenticate through the console or through the CLI. Use the console if you are setting up AstroPulse for the first time and want a guided flow.

Option 1: Console onboarding​

  1. Open the AstroPulse Console.
  2. Create or join an organization.
  3. Open Settings > API Keys.
  4. Create an API key for the organization.
  5. Export it in your shell:
export ASTROPULSE_API_KEY=your_api_key_here

With ASTROPULSE_API_KEY set, astroctl uses that key without running the browser login flow.

Option 2: CLI login​

Run:

astroctl auth login

This opens the login flow, creates a default organization if needed, generates an access key, and stores the local CLI config under ~/.config/astropulse/config.yaml.

If you already belong to an organization, list your organizations:

astroctl org list

Then log in for the organization you want to use:

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

You can also switch the active organization after login:

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

Verify Your Context​

Check the authenticated user, active organization, and current key:

astroctl whoami

The short alias also works:

astroctl me
Switching organizations

Run astroctl organization use <org-name-or-id> to switch between organizations you already have access to. Organization membership controls which clusters, profiles, applications, API keys, and integrations you can access.

Next Step​

Continue with Core Concepts to understand how organizations, clusters, profiles, and applications fit together.