|
1 |
| -# GitVault |
| 1 | +# GitGhost |
2 | 2 |
|
3 |
| -A simple way to keep your private files safe while sharing your code with the world. |
| 3 | +A simple CLI tool to securely manage private files and folders ignored in your public Git repositories. |
4 | 4 |
|
5 | 5 | ---
|
6 | 6 |
|
7 |
| -## Overview |
| 7 | +## Why use GitGhost? |
8 | 8 |
|
9 |
| -GitVault helps you **manage sensitive files and folders** that you don’t want in your public Git repo. It lets you back up and version those private files in a separate, secure repo — so you get the best of both worlds. |
| 9 | +- **Keep sensitive files private:** Manage secrets, configs, or personal files outside your public repo. |
| 10 | +- **Seamless Git integration:** Works alongside your existing Git workflow. |
| 11 | +- **Simple commands:** Easily save, check status, or discard private changes. |
| 12 | +- **Separate private repo:** Keeps your private data secure and versioned. |
| 13 | +- **Cross-platform:** Designed for Linux, works on any system with Python 3.10+. |
10 | 14 |
|
11 | 15 | ---
|
12 | 16 |
|
13 |
| -## What it does |
| 17 | +## Requirements |
14 | 18 |
|
15 |
| -- Use a `.gitvaultinclude` file to list private stuff you want to track (which should also be in `.gitignore`) |
16 |
| -- `gitvault init` sets up GitVault in your project, creating the private repo and config files |
17 |
| -- `gitvault status` shows what’s changed in your private files since your last save |
18 |
| -- `gitvault save` commits and pushes those private changes to your private repo |
19 |
| -- `gitvault discard` lets you throw away private changes you don’t want to keep |
20 |
| -- Keeps secrets out of your public repo, no surprises |
21 |
| -- Manual control — **you decide when to save, discard, or check** |
| 19 | +- **Python 3.10 or higher** |
| 20 | +- Compatible with Ubuntu/Linux systems |
| 21 | +- An existing Git repository |
22 | 22 |
|
23 | 23 | ---
|
24 | 24 |
|
25 |
| -## How to use it |
26 |
| - |
27 |
| -1. **Initialize GitVault** |
| 25 | +## Installation |
28 | 26 |
|
29 |
| -Run this once in your repo to set things up: |
| 27 | +Install GitGhost directly from PyPI: |
30 | 28 |
|
31 | 29 | ```bash
|
32 |
| -gitvault init |
| 30 | +pip install gitghost |
33 | 31 | ```
|
34 | 32 |
|
35 |
| -2. **List your private files** |
| 33 | +--- |
| 34 | + |
| 35 | +## Quick Start |
36 | 36 |
|
37 |
| -Create a `.gitvaultinclude` file with paths to your private files or folders (make sure they’re also in `.gitignore`): |
| 37 | +Initialize GitGhost in your project: |
38 | 38 |
|
39 |
| -``` |
40 |
| -secrets.env |
41 |
| -private_notes/ |
42 |
| -config/dev.yaml |
| 39 | +```bash |
| 40 | +gitghost init |
43 | 41 | ```
|
44 | 42 |
|
45 |
| -3. **See what’s changed** |
| 43 | +Check status of private files: |
46 | 44 |
|
47 | 45 | ```bash
|
48 |
| -gitvault status |
| 46 | +gitghost status |
49 | 47 | ```
|
50 | 48 |
|
51 |
| -4. **Save your private changes** |
| 49 | +Save private changes: |
52 | 50 |
|
53 | 51 | ```bash
|
54 |
| -gitvault save |
| 52 | +gitghost save |
55 | 53 | ```
|
56 | 54 |
|
57 |
| -5. **Discard private changes you don’t want** |
| 55 | +Discard private changes: |
58 | 56 |
|
59 | 57 | ```bash
|
60 |
| -gitvault discard |
| 58 | +gitghost discard |
61 | 59 | ```
|
62 | 60 |
|
63 |
| -That’s it — your sensitive stuff is safely versioned, but never exposed. |
64 |
| - |
65 | 61 | ---
|
66 | 62 |
|
67 |
| -## Installation |
68 |
| - |
69 |
| -_Coming soon on PyPI!_ |
70 |
| -For now, just clone this repo and install the dependencies: |
| 63 | +## How it works |
71 | 64 |
|
72 |
| -```bash |
73 |
| -pip install -r requirements.txt |
74 |
| -``` |
| 65 | +- Specify private files/folders in `.gitghostinclude` (which should also be in `.gitignore`). |
| 66 | +- GitGhost manages a **separate private repository** for these files. |
| 67 | +- `gitghost save` commits and pushes private changes. |
| 68 | +- `gitghost status` shows private file changes. |
| 69 | +- Keeps private data out of your public repo, but safely versioned. |
75 | 70 |
|
76 | 71 | ---
|
77 | 72 |
|
78 |
| -## Contributing |
| 73 | +## Links |
79 | 74 |
|
80 |
| -Ideas, bugs, or want to help out? |
81 |
| -Pull requests are welcome! Or just open an issue and let’s chat. |
| 75 | +- **PyPI:** (Coming soon) |
| 76 | +- **Source Code:** [https://github.com/decodingchris/gitghost](https://github.com/decodingchris/gitghost) |
| 77 | +- **Issue Tracker:** [https://github.com/decodingchris/gitghost/issues](https://github.com/decodingchris/gitghost/issues) |
82 | 78 |
|
83 | 79 | ---
|
84 | 80 |
|
85 | 81 | ## License
|
86 | 82 |
|
87 |
| -MIT License |
| 83 | +This project is licensed under the **MIT License**. See the [LICENSE](https://opensource.org/licenses/MIT) file for details. |
0 commit comments