Review the prerequisites and complete the following steps to get started with Acquia Code Studio:
The following prerequisites are required to use Acquia Code Studio:
The following skills are required to use Acquia Code Studio:
Important
The documentation assumes that you link Code Studio to your personal Acquia Cloud account through an SSH key. This may be considered a security risk. If a person can access your private SSH key in Code Studio, the person will have full access to any Acquia Cloud Platform application you have access to.
Acquia recommends creating a test account in Acquia Cloud Platform that you use exclusively for testing on Code Studio.
jane.doe+codestudio@acquia.com
.For more information on Acquia Cloud Platform user roles and permissions, see About Cloud Platform permissions.
You can accomplish either of the following using the Setting up a Code Studio project instructions:
By completing these instructions, you have a Code Studio with an AutoDevOps pipeline that automatically:
Create an Acquia Cloud IDE for your Acquia Cloud application.
Launch the Cloud IDE.
If you already have a Drupal application code on Acquia Cloud Platform, select Configure IDE and Copy Code From Cloud Platform.
To create a new Drupal application, run the acli new
command and select acquia/drupal-recommended-project
.
Generate a personal access token in Code Studio by performing the following steps:
Log in to Code Studio.
In the top right corner, click your profile icon.
Click Edit profile.
The system displays your user settings.
Click Access Tokens.
In the Add a personal access token section, provide the required details to create a new personal access token for authenticating with Code Studio.
In Name, enter a name for the token.
In Selected Scopes, select the api and write_repository checkboxes.
Click Create personal access token.
Code Studio creates your new personal access token and displays it on the screen.
Copy your new token.
Important
You must save your personal access token as you cannot access it again.
Run the following command to authenticate with Code Studio:
glab auth login
Select HTTPS when prompted.
Run the following commands to create and/or configure a Code Studio project for your Acquia Cloud application:
acli update
acli cs:wizard
The ACLI command walks you through the following process:
Note
Acquia Cloud Platform sends an email to your user account notifying that
an SSH key labeled CODESTUDIO_+key
is added to your Acquia account.
This is a normal, expected, and secure email that serves as a notification.
Requirements:
Complete the steps in the Setting up a Code Studio project.
Note
This includes an important step to run glab auth login
.
Use an Acquia Cloud IDE.
Use one of the following options to continue the process of pushing Drupal application code into your Code Studio project:
Requirements:
To push an existing Drupal application repository into Code Studio:
Navigate to your Drupal project directory on your local machine or in a Cloud IDE:
cd <git repository path on your local machine or Cloud IDE>
Push to Code Studio:
git remote add codestudio http://code.acquia.com/[gitlab-group]/[gitlab-project-name].git
git push codestudio <enter branch name>
To generate a new Drupal application repository:
acli new
command and select
acquia/drupal-recommended-project
.cd <directory name>
command.