idkgit is a tool that allows users with bash shell to conveniently do git actions to thier projects.
(Correctness of this project are only tested in macos recently !)
Before you begin, ensure you have met the following requirements:
- You have a device (recommended using mac) that is able to execute bash scripts
- You have read the instructions for using idkgit
To install idkgit follow these steps:
- Clone the repo :
git clone https://github.com/deeeelin/idkgit.git <folder path>
, or just download the zip file .
-
Enter
$SHLVL
in terminal and make sure the output is 1 , else restart terminal -
cd to the idkgit folder and execute start.bash
-
Restart your terminal
Please go through the following steps by doing it on your own computer~
Enter idk
to execute idkgit,and you will be in "select mode session".
In select mode session , you can enter:
clone
orcl
to clone repositories
ex : cloning repository of Rust into a folder "Rust_clone" under desktop
init
ori
to initialize git to your project
ex : initialize a directory "test2"
create
orcr
to make idkgit track a project your working
ex : track a project "test1"
list
orl
to see current project that idkgit is tracking
setcom
ors
to set commit message for pushing
ex : set commit message as "little updates from deeeelin"
push
orph
to push a project ,pull
orpl
to pull a project:
ex : pull main branch of "test1" from github to it's master branch at local
ex : push master branch of "test2" at local to it's main branch on github
if your "proj name" is all
then it will automaitcally push/pull all projects that idkgit is tracking , by referencing the same branch that is pushed/pulled previously of each project .
jump
orj
to change to one of a directory that idkgit is tracking,and automatically close idkgit
ex : jump to directory of "test2"
delete
ord
to cancel tracking a project
ex : cancel tracking "test1" , then cancel tracking all of the project.
out
oro
to close idkgit (only works when you're in select mode session).
- inside all mode mentioned above ,enter
b/
to jump back to "select mode session"
Very welcome to make contributes to idkgit ,or contact me to provide recommends for this project,very appreciate
To contribute to this project:
- Fork this repository.
- Create branch
- Make changes and commit them
- Push to your github
- Create pull request.
- Send a message to me via email
If you want to contact me you can reach me at [email protected]
This project uses the following license: MIT License.