Skip to main content

Setting up

Installing astroctl CLI​

The installation process for the AstroPulse CLI (astroctl) has been simplified.

Visit the AstroPulse Get Started page for complete installation instructions, including Homebrew installation options.

Once installed, verify your installation with:

astroctl --version

Onboarding​

AstroPulse offers two ways to onboard to the platform:

  1. Visit the AstroPulse Console and follow the guided onboarding process.
  2. Create or join an organization through the web interface.
  3. Access your API keys and other account settings directly from your profile.

Using API Keys from the UI​

If you prefer not to use the CLI login flow, you can:

  1. In the AstroPulse Console, navigate to Settings > API Keys
  2. Click "Create API Key" and select your organization
  3. Copy the generated API key (note: this is the only time you'll see the key)
  4. Set it as an environment variable in your terminal:
export ASTROPULSE_API_KEY=your_api_key_here

With this environment variable set, astroctl will use the API key for authentication without requiring the login command.

CLI Onboarding​

Alternatively, you can use the CLI for onboarding with these steps:

  1. Login to create a default organization and generate the access key for it:
astroctl auth login
  1. If you know the organization ID you want to be part of, contact the admin to add you to that organization. Once added, generate the access key for that specific organization by running the following command:
astroctl org list

  1. Find the organization ID (orgId) from the list of organizations you are part of.

  2. Generate the access key for the organization using the unique UUID orgId:

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

Run the following command to find which organization you are part of and what access key is configured for that organization. Switching between organization IDs, you need to re-login with orgId astroctl auth login --org-id.

astroctl whoami
Onboarded

Please ensure that you complete the onboarding process (either through UI or CLI) before using the platform. Without onboarding, you will not be able to access any of the platform's capabilities.