Before you install it there are a few requirements that must be met first.
Git is the open source version control system used by Platform.sh. Any change you make to your Platform.sh project will need to be committed via Git. You can see all the Git commit messages of an environment in the
Environment Activity feed of the management console for each project you create.
Before getting started, make sure you have Git installed on your computer.
Once your account has been set up and the CLI is installed, Platform.sh needs one additional piece of information about your computer so that you can access your projects from the command line. If you are unfamiliar with how to generate an SSH public and private key, there are instructions in the documentation about how to do so.
Add your SSH public key to your Platform.sh account so that you can communicate with your projects using the CLI.
Access SSH key settings in the management console
From the management console, move to the top right hand corner of the screen and click the dropdown menu to the left of the settings gear box icon. In the menu, click on
Account. This next page lists all of your active projects, which now includes
My First Project.
Click on the
Account Settingslink at the top of the page, then click the
SSH keystab to the left of your account information.
Add your SSH public key to your account
+ Add public keybutton in the top right hand corner of the screen. This will open up another window with two fields. Name the key with something memorable, like
home-computer, and in the field below that, paste the content of your public key.
When you have finished, click
Saveto save the key.
That's it! Now that you have met the requirements and configured an SSH key, all that's left is to install the Platform.sh CLI so you can interact with your projects from the command line.