Prerequisites

Hopscotch CLI is written for zsh on MacOS. Usage with different shells or UNIX-like OSs might result in misbehavior. This software relies on non-standard commandline tools (e.g. jq, httpie) that are automatically installed if missing using the brew package manager.

Hopscotch CLI does not require root privileges; this software comes as-is and should not be run as superuser.

Hopscotch CLI standard output uses colors and is optimized for dark themes—you might need to change your terminal's profile colors if you cannot see some output text.

Before the installation, you will need a working installation of the AWS CLI with a valid access key. Install the AWS CLI by running

brew install awscli

Setting up AWS credentials

1. Log in to the Hopscotch AWS Console with the user that has been set up for you; the account alias is hopscotch-labs.

2. Use the drop-down menu next to you user name and select Security Credentials.

3. If this is your first login, you will need to replace your temporary password.

4. You must set up MFA. All your user privileges are dependent on MFA being enabled. Without MFA enabled, the only action your user is allowed to perform is enabling MFA. Before you proceed to the next step, if you did not use MFA for your current login session (because you just set it up), you will have to log out of the AWS console and back in.

5. You can now create programmatic access keys for AWS CLI. In the Security Credentials page, select Create access keys. Select the CLI and accept the warning to create a new access key.

You can only see your Secret Key once on creation, so don't close the AWS Console page until you are done with the setup.

Hopscotch AWS user passwords expire every 30 days!

If you already use the AWS CLI and have already configured an access key, Hopscotch CLI support setting a profile for AWS commands issued by the CLI. Toggle the tab below to view next steps based on your situation.

Default installation

With the created Access Key and Secret Key, open your terminal again and type

aws configure

then paste in the Access Key ID and Secret Key that you just created. Use eu-west-1 as the region and json as the output format.

You can check your setup by running

aws sts get-caller-identity

Installation with AWS profile

Make sure to replace <profile_name>with the name you assigned to this AWS profile.

With the created Access Key and Secret Key, open your terminal again and type

aws configure --profile <profile_name>

then paste in the Access Key ID and Secret Key that you just created. Use eu-west-1 as the region and json as the output format.

You can check your setup by running

aws --profile <profile_name> sts get-caller-identity

Hopscotch AWS access keys are rotated monthly! Repeat this process when your access key is deactivated.