Difference between revisions of "HowTo - GIT & GitHub"

From Da Nerd Mage Wiki
Jump to navigation Jump to search
Tag: Reverted
 
(12 intermediate revisions by the same user not shown)
Line 1: Line 1:
Despite being owned by Microsoft these days, GitHub is a rather handy tool. Working with it through the Web Interface will only get you so far tho... So, here're some tips on using it from the command line. (Based on running Linux. Mac should be about the same. Dunno about Windows.)
Despite being owned by Microsoft these days, GitHub is a rather handy tool. Working with it through the Web Interface will only get you so far tho... So, here're some tips on using it from the command line. (Based on running Linux. Mac should be about the same. Dunno about Windows.)


* Required tools:
* Required tools:
** <code>sudo apt install git</code>
** <code>sudo apt install git</code>
** [https://github.com/cli/cli/blob/trunk/docs/install_linux.md Installing gh on Linux and BSD]
** [https://github.com/cli/cli/blob/trunk/docs/install_linux.md Installing gh on Linux and BSD]
***<code>curl -fsSL <nowiki>https://cli.github.com/packages/githubcli-archive-keyring.gpg</nowiki> | sudo dd of=/usr/share/keyrings/githubcli-archive-keyring.gpg</code>
***<code>curl -fsSL <nowiki>https://cli.github.com/packages/githubcli-archive-keyring.gpg</nowiki> {{!}} sudo dd of=/usr/share/keyrings/githubcli-archive-keyring.gpg</code>
***<code>sudo chmod go+r /usr/share/keyrings/githubcli-archive-keyring.gpg</code>
***<code>sudo chmod go+r /usr/share/keyrings/githubcli-archive-keyring.gpg</code>
***<code>echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/githubcli-archive-keyring.gpg] <nowiki>https://cli.github.com/packages</nowiki> stable main" | sudo tee /etc/apt/sources.list.d/github-cli.list > /dev/null</code>
***<code>echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/githubcli-archive-keyring.gpg] <nowiki>https://cli.github.com/packages</nowiki> stable main" {{!}} sudo tee /etc/apt/sources.list.d/github-cli.list &gt; /dev/null</code>
***<code>sudo apt update</code>
***<code>sudo apt update</code>
***<code>sudo apt install gh</code>
***<code>sudo apt install gh</code>
**Then you'll need to set up gh with your account
***<code>gh auth login</code>
**** & follow the directions.
* [https://docs.github.com/en/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax Basic writing and formatting syntax] (For your '''.md''' files)
* [https://docs.github.com/en/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax Basic writing and formatting syntax] (For your '''.md''' files)


==Creating a repository from scratch==
== Creating a repository from scratch ==
(Based on a local project folder)
(Based on a local project folder)


Line 29: Line 32:
</syntaxhighlight>
</syntaxhighlight>


==Pulling down a repository for local work==
== Pulling down a repository for local work ==
(Into a local project folder)
(Into a local project folder)


Line 37: Line 40:
</syntaxhighlight>
</syntaxhighlight>


==Uploading Changes to a Repository==
=== Syncing a local copy from GitHub ===
 
<syntaxhighlight lang="bash">
cd PROJECTFOLDER
gh repo sync
</syntaxhighlight>
 
== Uploading Changes to a Repository ==
(doesn't remove deleted files...)
(doesn't remove deleted files...)


<syntaxhighlight lang="bash">
<syntaxhighlight lang="bash">
cd '''PROJECTFOLDER'''
cd PROJECTFOLDER
git add *
git add *
git commit -m "'''MESSAGE'''"
git commit -m "MESSAGE"
git push  
git push  
</syntaxhighlight>
</syntaxhighlight>


==Removing file(s) from a repository==
== Removing file(s) from a repository ==


<syntaxhighlight lang="bash">
<syntaxhighlight lang="bash">
cd '''PROJECTFOLDER'''
cd PROJECTFOLDER
git rm '''FILESTOBEREMOVED'''
git rm FILESTOBEREMOVED
git commit -m "'''MESSAGE'''"
git commit -m "MESSAGE"
git push
git push
</syntaxhighlight>
</syntaxhighlight>

Latest revision as of 00:48, 24 September 2022

Despite being owned by Microsoft these days, GitHub is a rather handy tool. Working with it through the Web Interface will only get you so far tho... So, here're some tips on using it from the command line. (Based on running Linux. Mac should be about the same. Dunno about Windows.)

  • Required tools:
    • sudo apt install git
    • Installing gh on Linux and BSD
      • curl -fsSL https://cli.github.com/packages/githubcli-archive-keyring.gpg | sudo dd of=/usr/share/keyrings/githubcli-archive-keyring.gpg
      • sudo chmod go+r /usr/share/keyrings/githubcli-archive-keyring.gpg
      • echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/githubcli-archive-keyring.gpg] https://cli.github.com/packages stable main" | sudo tee /etc/apt/sources.list.d/github-cli.list > /dev/null
      • sudo apt update
      • sudo apt install gh
    • Then you'll need to set up gh with your account
      • gh auth login
        • & follow the directions.
  • Basic writing and formatting syntax (For your .md files)

Creating a repository from scratch

(Based on a local project folder)

cd PROJECTFOLDER                             # Location of existing local folder
vi README.md .gitignore                      # Create these useful files
git init                                     # 
git add README.md .gitignore                 # 
git commit -m "first commit"                 # 
git branch -M main                           # 
gh repo create REPONAME --source=. --private # Creating the actual Repo on GitHub
git push -u origin main                      # Push the folder layout & initial files

git add *                                    # Add in the rest of the project
git commit -m "second commit"
git push -u origin main                      # & push it...

Pulling down a repository for local work

(Into a local project folder)

cd ~/Projects                       # Location to create local folder
gh repo clone REPONAME

Syncing a local copy from GitHub

cd PROJECTFOLDER
gh repo sync

Uploading Changes to a Repository

(doesn't remove deleted files...)

cd PROJECTFOLDER
git add *
git commit -m "MESSAGE"
git push

Removing file(s) from a repository

cd PROJECTFOLDER
git rm FILESTOBEREMOVED
git commit -m "MESSAGE"
git push