https://github.com/suhaib3100/gitjet
GitJet CLI: A modern and stylish tool to simplify Git and GitHub workflows with both command-line and interactive UI options.
https://github.com/suhaib3100/gitjet
cli cliapp easy-git git giteasy github-actions gitjet simple-git
Last synced: about 1 year ago
JSON representation
GitJet CLI: A modern and stylish tool to simplify Git and GitHub workflows with both command-line and interactive UI options.
- Host: GitHub
- URL: https://github.com/suhaib3100/gitjet
- Owner: Suhaib3100
- License: apache-2.0
- Created: 2025-01-17T14:35:48.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-15T16:26:59.000Z (about 1 year ago)
- Last Synced: 2025-03-10T13:50:06.923Z (about 1 year ago)
- Topics: cli, cliapp, easy-git, git, giteasy, github-actions, gitjet, simple-git
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/gitjet
- Size: 70.3 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# GitJet CLI
GitJet is a modern and stylish CLI tool designed to simplify Git and GitHub workflows. Whether you're a beginner or an advanced user, GitJet streamlines the most common Git operations in a beautiful CLI with a seamless interactive UI. It offers both command-based and menu-driven options, giving you full flexibility.
---
## Features
- **Quick Commit**: Add, commit, and push all changes with one command.
- **Start Journey**: A beginner-friendly interactive guide to Git.
- **Start Repo**: Initialize and set up a new Git repository.
- **Pull Requests**: Create, list, and merge pull requests effortlessly.
- **Interactive Mode**: Enter an interactive menu to perform Git operations by simply typing and selecting options, no commands required.
- **Visual Feedback**: Get feedback with beautiful, styled output for better user experience.
---
## Installation
Install GitJet globally via npm:
```bash
npm install -g gitjet
```
---
## Usage
Once installed, GitJet can be used through commands or by simply typing `gitjet` to enter interactive mode.
### 1. Enter Interactive Mode (Default)
If you simply type `gitjet` without any additional commands, the tool will start in an interactive mode where you can select actions from a menu instead of typing commands manually.
```bash
gitjet
```
### 2. Start Journey (Perfect for Beginners)
Start your Git journey with an interactive guide.
```bash
gitjet journey
```
### 3. Quick Commit
Add, commit, and push all changes with a single command. You can optionally add a commit message using the `-m` flag.
```bash
gitjet quickcommit -m "Your commit message"
```
### 4. Start Repo
Initialize a new repository in the current directory.
```bash
gitjet start
```
### 5. Manage Pull Requests
Create, list, or merge pull requests.
- **Create a PR**:
```bash
gitjet pr --create
```
- **List PRs**:
```bash
gitjet pr --list
```
- **Merge a PR**:
```bash
gitjet pr --merge
```
---
## Example Workflow
Here is an example of a typical workflow with GitJet:
1. Start your Git journey if you're new to Git:
```bash
gitjet journey
```
2. Make changes to your repository.
3. Commit and push changes with:
```bash
gitjet quickcommit -m "Fixed issue #123"
```
4. Create a pull request with:
```bash
gitjet pr --create
```
5. Manage other pull requests with:
```bash
gitjet pr --list
gitjet pr --merge 1
```
---
## Contributing
GitJet is open-source, and contributions are welcome! If you'd like to contribute, feel free to fork the repository and submit a pull request. Please follow the standard Git workflow for contributing.
---
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
---
## Acknowledgements
GitJet was created with ❤️ by [Suhaib](https://github.com/Suhaib3100).
---
## Installation and Setup Notes
- Ensure you have Node.js and npm installed.
- GitJet uses `simple-git` for Git operations, `chalk` for terminal colors, and `ora` for spinner effects to enhance the user experience.
---
### Example Output for Quick Commit:
```
Processing quick commit...
Adding changes...
Staged files: ["src/index.js", "src/utils.js"]
Committing changes...
Changes successfully committed and pushed!
```
---
Enjoy using **GitJet** and simplify your Git workflow with style! 🚀