git-copilot-commit 0.1.8__tar.gz → 0.1.9__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: git-copilot-commit
3
- Version: 0.1.8
3
+ Version: 0.1.9
4
4
  Summary: Automatically generate and commit changes using copilot
5
5
  Author-email: Dheepak Krishnamurthy <1813121+kdheepak@users.noreply.github.com>
6
6
  License-File: LICENSE
@@ -15,6 +15,8 @@ Description-Content-Type: text/markdown
15
15
 
16
16
  AI-powered Git commit assistant that generates conventional commit messages using GitHub Copilot.
17
17
 
18
+ ![](https://github.com/user-attachments/assets/6a6d70a6-6060-44e6-8cf4-a6532e9e9142)
19
+
18
20
  ## Features
19
21
 
20
22
  - Generates commit messages based on your staged changes
@@ -69,39 +71,54 @@ git-copilot-commit commit
69
71
  ### Commit changes
70
72
 
71
73
  ```bash
72
- git-copilot-commit commit
73
- ```
74
-
75
- **Options:**
74
+ $ uvx git-copilot-commit commit --help
75
+ Usage: git-copilot-commit commit [OPTIONS]
76
76
 
77
- - `--all, -a`: Stage all files
78
- - `--verbose, -v`: Show detailed output
79
- - `--model, -m`: Choose an AI model
77
+ Automatically commit changes in the current git repository.
80
78
 
81
- Workflow:
82
-
83
- 1. Analyze changes
84
- 2. Prompt to stage files
85
- 3. Generate a commit message
86
- 4. Choose to commit, edit, or cancel
79
+ Options:
80
+ -a, --all Stage all files before committing
81
+ -v, --verbose Show verbose output
82
+ -m, --model TEXT Model to use for generating commit message
83
+ --help Show this message and exit.
84
+ ```
87
85
 
88
86
  ### Authenticate
89
87
 
90
88
  ```bash
91
- git-copilot-commit authenticate
89
+ $ uvx git-copilot-commit authenticate --help
90
+ Usage: git-copilot-commit authenticate [OPTIONS]
91
+
92
+ Autheticate with GitHub Copilot.
93
+
94
+ Options:
95
+ --help Show this message and exit.
92
96
  ```
93
97
 
94
98
  ### List models
95
99
 
96
100
  ```bash
97
- git-copilot-commit models
101
+ $ uvx git-copilot-commit models --help
102
+ Usage: git-copilot-commit models [OPTIONS]
103
+
104
+ List models available for chat in a Rich table.
105
+
106
+ Options:
107
+ --help Show this message and exit.
98
108
  ```
99
109
 
100
110
  ### Configure
101
111
 
102
112
  ```bash
103
- git-copilot-commit config --show
104
- git-copilot-commit config --set-default-model gpt-4o
113
+ $ uvx git-copilot-commit config --help
114
+ Usage: git-copilot-commit config [OPTIONS]
115
+
116
+ Manage application configuration.
117
+
118
+ Options:
119
+ --set-default-model TEXT Set default model for commit messages
120
+ --show Show current configuration
121
+ --help Show this message and exit.
105
122
  ```
106
123
 
107
124
  ## Examples
@@ -2,6 +2,8 @@
2
2
 
3
3
  AI-powered Git commit assistant that generates conventional commit messages using GitHub Copilot.
4
4
 
5
+ ![](https://github.com/user-attachments/assets/6a6d70a6-6060-44e6-8cf4-a6532e9e9142)
6
+
5
7
  ## Features
6
8
 
7
9
  - Generates commit messages based on your staged changes
@@ -56,39 +58,54 @@ git-copilot-commit commit
56
58
  ### Commit changes
57
59
 
58
60
  ```bash
59
- git-copilot-commit commit
60
- ```
61
-
62
- **Options:**
61
+ $ uvx git-copilot-commit commit --help
62
+ Usage: git-copilot-commit commit [OPTIONS]
63
63
 
64
- - `--all, -a`: Stage all files
65
- - `--verbose, -v`: Show detailed output
66
- - `--model, -m`: Choose an AI model
64
+ Automatically commit changes in the current git repository.
67
65
 
68
- Workflow:
69
-
70
- 1. Analyze changes
71
- 2. Prompt to stage files
72
- 3. Generate a commit message
73
- 4. Choose to commit, edit, or cancel
66
+ Options:
67
+ -a, --all Stage all files before committing
68
+ -v, --verbose Show verbose output
69
+ -m, --model TEXT Model to use for generating commit message
70
+ --help Show this message and exit.
71
+ ```
74
72
 
75
73
  ### Authenticate
76
74
 
77
75
  ```bash
78
- git-copilot-commit authenticate
76
+ $ uvx git-copilot-commit authenticate --help
77
+ Usage: git-copilot-commit authenticate [OPTIONS]
78
+
79
+ Autheticate with GitHub Copilot.
80
+
81
+ Options:
82
+ --help Show this message and exit.
79
83
  ```
80
84
 
81
85
  ### List models
82
86
 
83
87
  ```bash
84
- git-copilot-commit models
88
+ $ uvx git-copilot-commit models --help
89
+ Usage: git-copilot-commit models [OPTIONS]
90
+
91
+ List models available for chat in a Rich table.
92
+
93
+ Options:
94
+ --help Show this message and exit.
85
95
  ```
86
96
 
87
97
  ### Configure
88
98
 
89
99
  ```bash
90
- git-copilot-commit config --show
91
- git-copilot-commit config --set-default-model gpt-4o
100
+ $ uvx git-copilot-commit config --help
101
+ Usage: git-copilot-commit config [OPTIONS]
102
+
103
+ Manage application configuration.
104
+
105
+ Options:
106
+ --set-default-model TEXT Set default model for commit messages
107
+ --show Show current configuration
108
+ --help Show this message and exit.
92
109
  ```
93
110
 
94
111
  ## Examples
@@ -1,6 +1,6 @@
1
1
  [project]
2
2
  name = "git-copilot-commit"
3
- version = "0.1.8"
3
+ version = "0.1.9"
4
4
  description = "Automatically generate and commit changes using copilot"
5
5
  readme = "README.md"
6
6
  authors = [
@@ -57,7 +57,7 @@ wheels = [
57
57
 
58
58
  [[package]]
59
59
  name = "git-copilot-commit"
60
- version = "0.1.8"
60
+ version = "0.1.9"
61
61
  source = { editable = "." }
62
62
  dependencies = [
63
63
  { name = "platformdirs" },
@@ -0,0 +1,35 @@
1
+ # VHS script to showcase git-copilot-commit
2
+ # Run with: vhs < demo.vhs
3
+
4
+ # Set up the terminal
5
+ Set Shell "bash"
6
+ Set FontSize 14
7
+ Set Width 1200
8
+ Set Height 600
9
+ Set PlaybackSpeed 1.0
10
+ Set TypingSpeed 50ms
11
+ Set Theme "Catppuccin Mocha"
12
+
13
+ # Show the title
14
+ Type "# git-copilot-commit demo"
15
+ Enter
16
+ Enter
17
+ Sleep 2s
18
+
19
+ # Demonstrate the tool
20
+ Type "uv run git-copilot-commit commit"
21
+ Enter
22
+ Sleep 5s
23
+
24
+ Enter # Yes to stage files
25
+ Sleep 5s
26
+
27
+ Enter # Yes to commit
28
+ Sleep 5s
29
+
30
+ Type "git log --oneline --graph --all -n 5"
31
+ Enter
32
+
33
+ Sleep 10s
34
+
35
+ Output demo.gif