Getting Started
Install the AWS CLI
Although Granted doesn’t depend on the AWS CLI, we recommend installing it in order to run a test command to verify Granted is working properly.
Video Walkthrough
If you’d prefer to watch a video tutorial, Rowan from Common Fate has recorded an introduction to Granted on our Youtube channel.
Set up your AWS profile file
You will also need to set up at least one role in your AWS config file. On MacOS and Linux, this is stored in ~/.aws/config
. On Windows, this is stored in the %UserProfile%
directory. Some example configurations are included below.
If you use AWS SSO but you haven’t yet configured any profiles, you can run aws configure sso
which will walk you through the process of setting up your profile file.
If you’ve already set up roles for the AWS CLI to access AWS you probably don’t need to configure anything: Granted uses the same configuration files as the AWS CLI.
More information on using IAM users and roles can be found here.
Installing the CLI
In order to use Granted you’ll need to install it on your system. Common Fate provides binaries for Granted.
Using Homebrew
Homebrew is an open source package manager for MacOS. We publish a Homebrew formula for Granted. To install Granted with Homebrew, run the commands below in your terminal.
Manual install
Select the steps which match your system architecture. You can find your architecture by running uname -m
from a terminal window.
For Intel (x86_64 architecture):
For ARM (arm64 architecture):
Reverting to an older version of Granted
If you need to revert to an older version of Granted, you can manually downgrade using the following steps. First, make sure to uninstall your current version of granted. Replace “0.35.1” with the specific version you want to install.
Using Homebrew
For Intel (x86_64 architecture):
For ARM (arm64 architecture):
The assumego path is symlinked to granted so that they can both share keychain items without additional prompts. The homebrew install does this automatically but for a manual install on MacOS you’ll need to do it yourself.
Download the latest Granted release using APT by following the steps below. Our Linux releases are signed with a separate GPG key to our binary files.
Select the steps which match your system architecture. You can find your architecture by running uname -m
from a terminal window.
First, download the zip archive of Granted which matches your system’s architecture. You can find your architecture by viewing your system properties in the Control Panel.
After downloading Granted, unzip the package. Granted runs as two binaries, assume
and granted
. Any other files in the package can be removed, and Granted will still function.
You’ll need to move Granted to a folder that is accessible on your PATH
. This StackOverflow link has instructions on how to do this.
If you are using Granted with the Git Bash shell on Windows, we recommend enabling experimental support for pseudo consoles. You may need to reinstall Git For Windows to enable this. You can read more about this here.
Verify the installation
You can verify the integrity and authenticity of the Granted binary you have downloaded by running through the verification process here.
To verify that the installation has succeeded, print the version of Granted by running granted -v
. You should see an output similar to below.
If you have any issues installing don’t hesitate to ask for help on our Slack.
Next steps
Now that you’ve installed Granted, it’s time to assume your first role.