Git Cheat Sheet
ShaunDreclin edited this page Mar 24, 2018
·
4 revisions
For a more in-depth guide, see Beginner's Guide To Git.
• Stuff in ALL_CAPS needs to be filled in.
• Never work in your master branch, it should always be a copy of upstream/master
• Branch names are generally all-lowercase-with-dashes-between-words
• Commit messages should use present-tense imperative verbs. (Change, not Changed)
------------
Download a repo from github to work on it locally (From parent folder)
You want to download *your* repo that you forked from the main project.
git clone https://github.com/SOME_PERSON/SOME_PROJECT.git
git clone https://github.com/YOUR_USERNAME/runelite.git
Add remote (You should add the main project as a remote)
git remote add REMOTE_NAME https://github.com/SOME_PERSON/SOME_PROJECT.git
git remote add upstream https://github.com/runelite/runelite.git
Rename remote
git remote rename OLD_REMOTE_NAME NEW_REMOTE_NAME
Check remotes
git remote -v
Delete remote
git remote rm REMOTE_NAME
------------
Create a new branch (will copy from your current branch)
git checkout -b BRANCH_NAME
Change current branch
git checkout BRANCH_NAME
Check branches
git branch -v
Delete remote branch
git push -d REMOTE_NAME BRANCH_NAME
Delete local branch
git branch -d BRANCH_NAME
------------
Check the status of the current branch.
Files modified/added/removed will be in red, files in the staging area in green
git status
Add a modified/added/removed file to the staging area
git add FILE_NAME.txt
git add *.txt
Add ALL modified/added/removed to the staging area (Capital A required)
git add -A
Commit with a descriptive message saying what you did
git commit -m "COMMIT_MESSAGE"
------------
Push branch to github
git push remotename branchname
Pull branch from github
git pull remotename branchname
Check differences in pull conflicts
git diff HEAD
------------
Fetch branches from upstream (do this before rebasing)
git fetch upstream
Switch to master branch
git checkout master
Rebase changes from upstream to local copy
git rebase upstream/master
Switch to working branch
git checkout BRANCH_NAME
Rebase local working branch from local master branch
git rebase master
Please join our Discord if you notice anything wrong or would like to discuss an addition to the wiki. Changes can be submitted to our wiki repository.
User Guide
- FAQ
- GPU FAQ
- RuneLite Launcher Configuration
- Verifying Launcher Authenticity
- Troubleshooting problems with the client
- Disable Hardware Acceleration
- Change DPI Scaling (Ubuntu 20 w/ Gnome)
- Information about the Plugin Hub
- General Features
-
Plugin Configuration
- Agility
- Ammo
- Animation Smoothing
- Anti Drag
- Attack Styles
- Bank
- Bank Tags
- Barbarian Assault
- Barrows Brothers
- Blast Furnace
- Blast Mine
- Boosts Information
- Boss Timers
- Camera
- Cannon
- Chambers of Xeric
- Chat Channels
- Chat Color
- Chat Commands
- Chat Filter
- Chat History
- Chat Notifications
- Chat Timestamps
- Clue Scroll
- Combat Level
- Cooking
- Corporeal Beast
- Custom Cursor
- Daily Task Indicator
- Default World
- Diary Requirements
- Discord
- DPS Counter
- Emojis
- Entity Hider
- Examine
- FPS Control
- Fairy Rings
- Fishing
- Friend List
- Friend Notes
- GPU
- Grand Exchange
- Ground Items
- Ground Markers
- Herbiboar
- HiScore
- Hunter
- Idle Notifier
- Implings
- Info Panel
- Instance Map
- Interface Styles
- Inventory Grid
- Inventory Tags
- Inventory Viewer
- Item Charges
- Item Identification
- Item Prices
- Item Stats
- Key Remapping
- Kingdom of Miscellania
- Kourend Library
- Login Screen
- Loot Tracker
- Low Detail
- Mage Training Arena
- Menu Entry Swapper
- Metronome
- Minimap
- Mining
- Motherlode Mine
- Mouse Tooltips
- Music
- NPC Aggression Timer
- NPC Indicators
- Nightmare Zone
- Notes
- Object Markers
- Opponent Information
- Party
- Pest Control
- Player Indicators
- Player-owned House
- Poison
- Prayer
- Puzzle Solver
- Pyramid Plunder
- Quest List
- Random Events
- Regeneration Meter
- Report Button
- Run Energy
- Rune Pouch
- RuneLite
- Runecraft
- Screen Markers
- Screenshot
- Skill Calculator
- Skybox
- Slayer
- Smelting
- Special Attack Counter
- Status Bars
- Stretched Mode
- Team Capes
- Tears Of Guthix
- Tile Indicators
- Time Tracking
- Timers
- Tithe Farm
- Twitch
- Virtual Levels
- Wiki
- Wintertodt
- Woodcutting
- World Hopper
- World Map
- XP Drop
- XP Globes
- XP Tracker
- XP Updater
- Zalcano
Developer's Guide
- Plugin Development
- RuneLite Core Development
- Using Git with RuneLite
- Using Jagex Accounts
- Working with client scripts
- Using the client developer tools
- VarPlayers, VarBits, and VarClients
- Rejected or Rolled Back Features