1
0
mirror of synced 2025-12-21 19:06:49 -05:00
Files
docs/content/get-started/using-git/splitting-a-subfolder-out-into-a-new-repository.md
2021-12-11 03:10:36 +00:00

3.8 KiB

title, redirect_from, intro, versions, shortTitle
title redirect_from intro versions shortTitle
Splitting a subfolder out into a new repository
/articles/splitting-a-subpath-out-into-a-new-repository
/articles/splitting-a-subfolder-out-into-a-new-repository
/github/using-git/splitting-a-subfolder-out-into-a-new-repository
/github/getting-started-with-github/splitting-a-subfolder-out-into-a-new-repository
/github/getting-started-with-github/using-git/splitting-a-subfolder-out-into-a-new-repository
You can turn a folder within a Git repository into a brand new repository.
fpt ghes ghae ghec
* * * *
Splitting a subfolder

If you create a new clone of the repository, you won't lose any of your Git history or changes when you split a folder into a separate repository.

{% data reusables.command_line.open_the_multi_os_terminal %}

  1. Change the current working directory to the location where you want to create your new repository.

  2. Clone the repository that contains the subfolder.

    $ git clone https://{% data variables.command_line.codeblock %}/<em>USERNAME</em>/<em>REPOSITORY-NAME</em>
    
  3. Change the current working directory to your cloned repository.

    $ cd <em>REPOSITORY-NAME</em>
    
  4. To filter out the subfolder from the rest of the files in the repository, run git filter-repo, supplying this information:

    • FOLDER-NAME: The folder within your project where you'd like to create a separate repository.

    {% windows %}

    {% tip %}

    Tip: Windows users should use / to delimit folders.

    {% endtip %}

    {% endwindows %}

    $ git filter-repo --path FOLDER-NAME1/ --path FOLDER-NAME2/
    # Filter the specified branch in your directory and remove empty commits
    > Rewrite 48dc599c80e20527ed902928085e7861e6b3cbe6 (89/89)
    > Ref 'refs/heads/<em>BRANCH-NAME</em>' was rewritten
    

    The repository should now only contain the files that were in your subfolder(s).

  5. Create a new repository on {% data variables.product.product_name %}.

  6. At the top of your new repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}'s Quick Setup page, click {% octicon "clippy" aria-label="The copy to clipboard icon" %} to copy the remote repository URL.

    Copy remote repository URL field

    {% tip %}

    Tip: For information on the difference between HTTPS and SSH URLs, see "About remote repositories."

    {% endtip %}

  7. Check the existing remote name for your repository. For example, origin or upstream are two common choices.

    $ git remote -v
    > origin  https://{% data variables.command_line.codeblock %}/<em>USERNAME/REPOSITORY-NAME</em>.git (fetch)
    > origin  https://{% data variables.command_line.codeblock %}/<em>USERNAME/REPOSITORY-NAME</em>.git (push)
    
  8. Set up a new remote URL for your new repository using the existing remote name and the remote repository URL you copied in step 7.

    git remote set-url origin https://{% data variables.command_line.codeblock %}/<em>USERNAME/NEW-REPOSITORY-NAME</em>.git
    
  9. Verify that the remote URL has changed with your new repository name.

    $ git remote -v
    # Verify new remote URL
    > origin  https://{% data variables.command_line.codeblock %}/<em>USERNAME/NEW-REPOSITORY-NAME</em>.git (fetch)
    > origin  https://{% data variables.command_line.codeblock %}/<em>USERNAME/NEW-REPOSITORY-NAME</em>.git (push)
    
  10. Push your changes to the new repository on {% data variables.product.product_name %}.

    git push -u origin <em>BRANCH-NAME</em>