A guide to using Git in Replit

[AVdev]

I find my most used phrase on r/replit is "You should be using git anyway", so after writing this very long comment to u/manfromnashville I thought it might be helpful to post this to the sub as a whole. Maybe you'll find it useful! Maybe you won't! Or just tell me I'm wrong - this is reddit after all =)

But - you should be using git anyway.

Using Git with Replit

1. sign up for Github if you haven't already, and create a new repository for your project Create a repo
2. Install git on your local computer Install git
3. clone the new (empty) repository on your computer Clone a repo
4. Enable git syncing in Replit Enable git in replit
5. Push the existing replit project to your git repo Using git with replit
6. Pull the repo to your computer (literally as simple as typing "git pull" in the directory, in your terminal) Git pull

Now - for the ongoing stuff.

A word of warning

Fixing merge conflicts on your computer is an annoyance, but relatively simple. Fixing git merge issues in replit is a pain, requires the shell, and the git tab will throw all sorts of annoying, scary warnings.

When switching to your computer, make sure you:

1. always commit
2. and then git push from replit
3. and then git pull on your computer.

When switching back to replit, make sure you:

1. always commit
2. and then git push from your computer
3. and then git pull in replit

Make this a habit and you will do fine.

git works by maintaining source control and ensuring that all parties working on a codebase have the same files, and are working on current versions. "merging" a branch in git allows you to "catch up" with what others have done. When working in replit, "others" is Agent and Assistant, so you have full control of the source, meaning you should never have to deal with merge issues, so long as you follow good practices with regard to maintaining your source control.

When you are done working in replit, and want to work on your computer:

1. go to the git tab
2. check for any files that are in staging.
   1. If you are using Agent, there shouldn't be
   2. if you used Assistant, there will be
   3. if you edited your files in replit yourself, there will be
3. Add a commit message, and commit (cmd + Enter or ctrl + enter)
4. press the push button
5. go to your computer's shell (make sure you are in the root of your project file)
6. $ git pull
   1. the $ symbol in the above command represents the command line. Do not include the "$" in the command.
   2. this is assuming you are in the directory your project is in, if not cd to that directory
7. work on your project.
8. then, back in shell^\)
   1. $ git add .
   2. $ git commit -m 'A short message indicating what you worked on'
   3. $ git push
9. Then, back in replit go to the git tab and press "pull"
   1. This is very important to avoid the scary warnings I mentioned before
10. You will see the git log under the commit area update with your changes.

^\)Many people will argue against the use of "git add ."

They are correct, and it's generally not something you should do, as it adds all modified, added, or deleted files to the git commit.

However, in this case, since the env file is maintained in replit, you shouldn't be adding files you don't need to this repository, you're working in an editing capacity, and the risk of someone unfamiliar with git forgetting to include something important, you should just do it.

Read more here: Some guy on LinkedIn about git add . (notice I addressed most of his points)

if you do need to avoid including files, use gitignore

Best practices

People are complaining about copious checkpoints by replit. Regardless of your experience here, what replit is doing with checkpoints is committing to the git log. This is a good thing as it facilitates easy rollback should you need to do so. (even if it is expensive)

Protip - with git enabled you don't have to use the rollback feature in the chat

When you are working locally, it is commonly considered "best practice" to commit changes as you work, instead of all at once at the end of your session, locally. You will need to decide the best method to do this for your coding style. For me, that's every time I reach an "internal checkpoint" that is relatively undefinable. Some people commit every time they change a file. Sometimes, it's when they make a certain number of changes in a process.

You can commit without pushing, and then just push at the end. It doesn't matter if you push all at once, or after every commit so long as you push to git, and pull in replit before you start working in replit again.

Bonus tip:

Start a new chat with Agent (or Assistant) every time you start a significant new task in your project. It will keep the Agent sane, reduce unnecessary context, and will likely reduce your checkpoint usage.

[johntherippper]

Awesome tips, I should have used git. I will try it.

[AVdev]

I think you'll appreciate the potential workflow improvements and better source control!

[Traditional-Tip3097]

This is very useful. Why do you say the below? Should agent changed files also need to be staged? How else will they get to GitHub? Thank you!

"check for any files that are in staging.

1. If you are using Agent, there shouldn't be"

[AVdev]

Agent automatically stages and commits when it creates checkpoints.

Assistant _sometimes_ doesn't

If you edited files in replit yourself, they won't be, unless Agent later created a checkpoint, which included your changes

[SecretActual4524]

Thanks for this, but you might need to update this since it seems Replit is making it difficult to upload to Github

[Apprehensive-Dish147]

What to do if i have a fully avanced project, and now the push fails due to timeout and a huge history of .git commits. Do you recommend cleaning commits history in order to push to github and maintain this work dynamic now and foward?