How To Use GitHub With Cursor AI

Introduction

This tutorial guides you through using GitHub with Cursor AI, providing step-by-step instructions on setting up Git, creating repositories, and integrating version control into your development workflow. Whether you're a beginner or refreshing your skills, you'll learn to manage your projects effectively and collaborate seamlessly.

Step 1: Create a GitHub Account

1. Visit the GitHub website at github.com.
2. Click on the "Sign Up" button.
3. Fill in the required details such as username, email, and password.
4. Follow the prompts to verify your email address and complete your account setup.

Step 2: Install Git

1. Download Git from the official site at git-scm.com.
2. Choose the appropriate version for your operating system (Windows, macOS, or Linux).
3. Follow the installation instructions based on your platform.
   • For Windows, use the installer and select default options.
   • For macOS, you can install via Homebrew with the command:

     brew install git
     

Step 3: Configure Git

1. Open your command line interface (CLI).
2. Set your username and email by entering the following commands:

   git config --global user.name "Your Name"
   git config --global user.email "your.email@example.com"
   

3. Verify your configuration with:

   git config --list
   

Step 4: Initialize a Repository in Cursor AI

1. Open Cursor AI and start a new project.
2. In the project folder, open the CLI.
3. Initialize a new Git repository with:

   git init
   

Step 5: Stage and Commit Changes

1. Make changes to your code in Cursor AI.
2. Stage the changes with:

   git add .
   

   • This command stages all modified files. Adjust the dot to specify individual files if needed.
3. Commit the changes with a message:

   git commit -m "Your commit message"
   

Step 6: Publish Your Repository to GitHub

1. Create a new repository on GitHub.
2. Copy the repository URL.
3. Link the local repository to GitHub:

   git remote add origin <repository-url>
   

4. Push your changes to GitHub:

   git push -u origin master
   

Step 7: Sync Changes Between Cursor and GitHub

1. Whenever you make changes, repeat the staging and committing process.
2. To push your updates to GitHub, use:

   git push
   

Step 8: Advanced Git Techniques

• Discarding Uncommitted Changes: To revert changes in a file:

  git checkout -- <file-name>
  

• Rolling Back Committed Changes: If you want to undo the last commit:

  git reset --soft HEAD~1
  

• Forced Push: To overwrite a remote branch:

  git push --force
  

Step 9: Forking and Cloning Repositories

1. To fork a repository, go to the GitHub page of the project and click on "Fork."
2. Clone your forked repository to your local machine:

   git clone <your-fork-url>
   

Conclusion

You now have the foundational skills to use GitHub with Cursor AI effectively. You've learned how to create and configure a GitHub account, initialize repositories, stage and commit changes, publish your work, and utilize advanced Git features. To further enhance your skills, explore GitHub's collaboration features and consider contributing to open-source projects. Happy coding!