Co-authored-by: Kevin Heis <heiskr@users.noreply.github.com> Co-authored-by: Sarah Schneider <sarahs@github.com> Co-authored-by: Vanessa <vgrl@github.com>
12 KiB
title, intro, redirect_from, versions, shortTitle
| title | intro | redirect_from | versions | shortTitle | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Adding locally hosted code to GitHub | If your code is stored locally on your computer, you can import the code to {% data variables.product.product_name %} using {% data variables.product.prodname_cli %} or Git commands. |
|
|
Add local code |
About adding existing source code to {% data variables.product.product_name %}
If you have source code stored locally on your computer, you can add the code to {% data variables.product.product_name %} by typing commands in a terminal. You can do this by typing Git commands directly, or by using {% data variables.product.prodname_cli %}.
{% data variables.product.prodname_cli %} is an open source tool for using {% data variables.product.prodname_dotcom %} from your computer's command line. {% data variables.product.prodname_cli %} can simplify the process of adding an existing project to {% data variables.product.product_name %} using the command line. To learn more about {% data variables.product.prodname_cli %}, see "AUTOTITLE."
{% tip %}
Tip: If you're most comfortable with a point-and-click user interface, try adding your project with {% data variables.product.prodname_desktop %}. For more information, see "AUTOTITLE" in the {% data variables.product.prodname_desktop %} Help.
{% endtip %}
{% data reusables.repositories.sensitive-info-warning %}
Adding a local repository to {% data variables.product.product_name %} with {% data variables.product.prodname_cli %}
-
In the command line, navigate to the root directory of your project.
-
Initialize the local directory as a Git repository.
git init -b main -
Stage and commit all the files in your project.
git add . && git commit -m "initial commit" -
To create a repository for your project on GitHub, use the
gh repo createsubcommand. When prompted, select Push an existing local repository to GitHub and enter the desired name for your repository. If you want your project to belong to an organization instead of your user account, specify the organization name and project name withorganization-name/project-name. -
Follow the interactive prompts. To add the remote and push the repository, confirm yes when asked to add the remote and push the commits to the current branch.
-
Alternatively, to skip all the prompts, supply the path to the repository with the
--sourceflag and pass a visibility flag (--public,--private, or--internal). For example,gh repo create --source=. --public. Specify a remote with the--remoteflag. To push your commits, pass the--pushflag. For more information about possible arguments, see the GitHub CLI manual.
Adding a local repository to {% data variables.product.product_name %} using Git
{% mac %}
-
Create a new repository on {% data variables.location.product_location %}. To avoid errors, do not initialize the new repository with README, license, or
gitignorefiles. You can add these files after your project has been pushed to {% data variables.product.product_name %}.
{% data reusables.command_line.open_the_multi_os_terminal %} -
Change the current working directory to your local project.
-
Use the
initcommand to initialize the local directory as a Git repository. By default, the initial branch is calledmain.If you’re using Git 2.28.0 or a later version, you can set the name of the default branch using
-b.$ git init -b mainIf you’re using Git 2.27.1 or an earlier version, you can set the name of the default branch using
&& git symbolic-ref HEAD refs/heads/main.$ git init && git symbolic-ref HEAD refs/heads/main -
Add the files in your new local repository. This stages them for the first commit.
$ git add .
# Adds the files in the local repository and stages them for commit. {% data reusables.git.unstage-codeblock %}
- Commit the files that you've staged in your local repository.
$ git commit -m "First commit"
# Commits the tracked changes and prepares them to be pushed to a remote repository. {% data reusables.git.reset-head-to-previous-commit-codeblock %}
- At the top of your repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %}'s Quick Setup page, click {% octicon "clippy" aria-label="The copy to clipboard icon" %} to copy the remote repository URL.

- In Terminal, add the URL for the remote repository where your local repository will be pushed.
$ git remote add origin <REMOTE_URL>
# Sets the new remote
$ git remote -v
# Verifies the new remote URL
- Push the changes in your local repository to {% data variables.location.product_location %}.
$ git push -u origin main
# Pushes the changes in your local repository up to the remote repository you specified as the origin
{% endmac %}
{% windows %}
-
Create a new repository on {% data variables.location.product_location %}. To avoid errors, do not initialize the new repository with README, license, or
gitignorefiles. You can add these files after your project has been pushed to {% data variables.product.product_name %}.
{% data reusables.command_line.open_the_multi_os_terminal %} -
Change the current working directory to your local project.
-
Use the
initcommand to initialize the local directory as a Git repository. By default, the initial branch is calledmain.If you’re using Git 2.28.0 or a later version, you can set the name of the default branch using
-b.$ git init -b mainIf you’re using Git 2.27.1 or an earlier version, you can set the name of the default branch using
&& git symbolic-ref HEAD refs/heads/main.$ git init && git symbolic-ref HEAD refs/heads/main -
Add the files in your new local repository. This stages them for the first commit.
$ git add .
# Adds the files in the local repository and stages them for commit. {% data reusables.git.unstage-codeblock %}
- Commit the files that you've staged in your local repository.
$ git commit -m "First commit"
# Commits the tracked changes and prepares them to be pushed to a remote repository. {% data reusables.git.reset-head-to-previous-commit-codeblock %}
- At the top of your repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %}'s Quick Setup page, click {% octicon "clippy" aria-label="The copy to clipboard icon" %} to copy the remote repository URL.

- In the Command prompt, add the URL for the remote repository where your local repository will be pushed.
$ git remote add origin <REMOTE_URL>
# Sets the new remote
$ git remote -v
# Verifies the new remote URL
- Push the changes in your local repository to {% data variables.location.product_location %}.
$ git push origin main
# Pushes the changes in your local repository up to the remote repository you specified as the origin
{% endwindows %}
{% linux %}
-
Create a new repository on {% data variables.location.product_location %}. To avoid errors, do not initialize the new repository with README, license, or
gitignorefiles. You can add these files after your project has been pushed to {% data variables.product.product_name %}.
{% data reusables.command_line.open_the_multi_os_terminal %} -
Change the current working directory to your local project.
-
Use the
initcommand to initialize the local directory as a Git repository. By default, the initial branch is calledmain.If you’re using Git 2.28.0 or a later version, you can set the name of the default branch using
-b.$ git init -b mainIf you’re using Git 2.27.1 or an earlier version, you can set the name of the default branch using
&& git symbolic-ref HEAD refs/heads/main.$ git init && git symbolic-ref HEAD refs/heads/main -
Add the files in your new local repository. This stages them for the first commit.
$ git add .
# Adds the files in the local repository and stages them for commit. {% data reusables.git.unstage-codeblock %}
- Commit the files that you've staged in your local repository.
$ git commit -m "First commit"
# Commits the tracked changes and prepares them to be pushed to a remote repository. {% data reusables.git.reset-head-to-previous-commit-codeblock %}
- At the top of your repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %}'s Quick Setup page, click {% octicon "clippy" aria-label="The copy to clipboard icon" %} to copy the remote repository URL.

- In Terminal, add the URL for the remote repository where your local repository will be pushed.
$ git remote add origin <REMOTE_URL>
# Sets the new remote
$ git remote -v
# Verifies the new remote URL
- Push the changes in your local repository to {% data variables.location.product_location %}.
$ git push origin main
# Pushes the changes in your local repository up to the remote repository you specified as the origin
{% endlinux %}