Skip to main content

Running GitHub repositories on Replit

GitHub repositories can be run automatically on Replit. Head to https://replit.com/github to import a repository. Any public repository under 500 MB (or 1GB with Hacker plan) can be cloned. You can unlock private repos after authenticating with GitHub and purchasing private repls with Cycles or with our Hacker plan.

import modal

From the modal above, you can select the repo, language, and owner of the repl. We will automatically detect the language if your GitHub repository already has a .replit file!

Configuring a Cloned Repo

When you clone a repository without a .replit file, we automatically show the visual .replit editor:

Visual config editor

This will automatically create the .replit file and make it possible to customize how the repl will run.

You can use the shell to run any command and then set the "Run" button once you've decided what it should do.

Clicking "done" will finalize the repl's configuration and close the visual editor.

It's always possible to make changes later by visiting the .replit file from the filetree. Adding .replit to a repository makes cloning fast with no configuration necessary.

For more information on how to configure your repl, see the .replit documentation.

Adding a "Run on Replit" Badge

After configuring a run command for your repl, you can add a badge to your repository README that will allow anyone to run your project automatically!

Generate a badge