Setting up

This section provides a guide to installing the astroctl CLI.

UI/UX

The UI/UX is not available yet!

CLI Download

To get started with astroctl, follow these steps:

1. Log in to the AstroPulse Console to access the download option for the astroctl CLI.

2. Once downloaded, move the astroctl binary to a directory of your choice. It is recommended to place it in a directory that is included in your system's PATH for easy access from the terminal. For example, you can move it to /usr/local/bin on Unix-like systems.

3. Open your terminal and navigate to the directory where you downloaded the file and run.

   tar -xzf  /path/to/download/folder/<file_name>.tar.gz 

   For example for mac (M1 chip)

   tar -xzf $HOME/Downloads/astroctl-darwin.arm64.tar.gz

4. Make the astroctl binary executable by running the following command:

   chmod +x astroctl

5. If you haven't already moved astroctl to a directory in your PATH (e.g., /usr/local/bin), you can do so by running the following command:

   sudo mv astroctl /usr/local/bin

   This step allows you to run astroctl from any directory in your terminal.

   Mac Permission

   Make sure to grant permission before moving to /usr/local/bin.

6. Verify the installation by running the following command:

   Download

   astroctl --version

   Make sure to check the changelog to see if the capability you are looking for exists.

   This command should display the version of astroctl you have installed, confirming a successful installation.

By following these steps, you will have astroctl installed and ready to use on your system.

Onboarding

To onboard to the platform, you need to perform the following steps:

1. Login to create a default organization and generate the access key for it:

astroctl auth login

2. 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

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

4. 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 before using the platform. Without onboarding, you will not be able to access any of the platform's capabilities.