File tree Expand file tree Collapse file tree 4 files changed +20
-16
lines changed Expand file tree Collapse file tree 4 files changed +20
-16
lines changed Original file line number Diff line number Diff line change 2
2
3
3
Private version control for your Git ignored files.
4
4
5
- ---
6
-
7
5
## Why use GitGhost?
8
6
9
7
- ** Keep sensitive files private:** Manage secrets, configs, or personal files outside your public repo.
@@ -12,16 +10,12 @@ Private version control for your Git ignored files.
12
10
- ** Separate private repo:** Keeps your private data secure and versioned.
13
11
- ** Cross-platform:** Designed for Linux, works on any system with Python 3.10+.
14
12
15
- ---
16
-
17
13
## Requirements
18
14
19
15
- Python 3.10 or higher
20
16
- Git installed
21
17
- GitHub CLI (` gh ` ) is required for private repo automation
22
18
23
- ---
24
-
25
19
## Installation
26
20
27
21
Install GitGhost directly from PyPI:
@@ -30,9 +24,7 @@ Install GitGhost directly from PyPI:
30
24
pip install gitghost
31
25
```
32
26
33
- ---
34
-
35
- ## Quick Start
27
+ ## Commands
36
28
37
29
Initialize GitGhost in your project:
38
30
@@ -58,7 +50,11 @@ Discard private changes:
58
50
gitghost discard
59
51
```
60
52
61
- ---
53
+ Get help and list all commands:
54
+
55
+ ``` bash
56
+ gitghost help
57
+ ```
62
58
63
59
## How it works
64
60
@@ -68,16 +64,12 @@ gitghost discard
68
64
- ` gitghost status ` shows private file changes.
69
65
- Keeps private data out of your public repo, but safely versioned.
70
66
71
- ---
72
-
73
67
## Links
74
68
75
69
- ** PyPI:** [ https://pypi.org/project/gitghost/ ] ( https://pypi.org/project/gitghost/ )
76
70
- ** Source Code:** [ https://github.com/decodingchris/gitghost ] ( https://github.com/decodingchris/gitghost )
77
71
- ** Issue Tracker:** [ https://github.com/decodingchris/gitghost/issues ] ( https://github.com/decodingchris/gitghost/issues )
78
72
79
- ---
80
-
81
73
## License
82
74
83
75
This project is licensed under the ** MIT License** . See the [ LICENSE] ( https://opensource.org/licenses/MIT ) file for details.
Original file line number Diff line number Diff line change @@ -301,6 +301,12 @@ def block_present(content):
301
301
with open (gitignore_path , "w" ) as f :
302
302
f .write (vault_block )
303
303
click .echo ("Created .gitignore with GitGhost block" )
304
+ @cli .command ()
305
+ @click .pass_context
306
+ def help (ctx ):
307
+ """Show this message and exit."""
308
+ click .echo (cli .get_help (ctx ))
309
+
304
310
305
311
if __name__ == "__main__" :
306
312
cli ()
Original file line number Diff line number Diff line change @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
4
4
5
5
[project ]
6
6
name = " gitghost"
7
- version = " 1.0.2 "
7
+ version = " 1.0.3 "
8
8
description = " Private version control for your Git ignored files."
9
9
authors = [
10
10
{ name = " Decoding Chris" }
Original file line number Diff line number Diff line change @@ -281,4 +281,10 @@ def test_cli_entry_point():
281
281
# Cover line 300
282
282
from gitghost import cli as cli_module
283
283
with pytest .raises (SystemExit ):
284
- cli_module .cli ()
284
+ cli_module .cli ()
285
+
286
+ def test_help_command (runner ):
287
+ result = runner .invoke (cli , ['help' ])
288
+ assert result .exit_code == 0
289
+ assert 'Usage:' in result .output
290
+ assert 'Commands:' in result .output
You can’t perform that action at this time.
0 commit comments