gitwrit 0.2.7 → 0.2.8
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.
- package/README.md +40 -5
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Made for `git`-ters and `writ`-ters.
|
|
6
6
|
|
|
7
|
-
**gitwrit** watches your Markdown files and quietly commits and pushes them to your Git repository
|
|
7
|
+
**gitwrit** watches your Markdown files and quietly commits and pushes them to your Git repository—no manual `git add`, no `git commit`, no `git push`. You write. gitwrit handles the rest.
|
|
8
8
|
|
|
9
9
|
It is built for engineers writing internal specs, researchers building private knowledge bases, AI practitioners documenting models and experiments, and anyone who wants the safety of version control without the overhead of Git discipline. Your files stay in your own repository, on your own terms—not in someone else's cloud.
|
|
10
10
|
|
|
@@ -99,9 +99,9 @@ Run `gitwrit config` from inside a watched directory to set local overrides. Ove
|
|
|
99
99
|
|
|
100
100
|
gitwrit supports two branch modes, configurable globally or per directory.
|
|
101
101
|
|
|
102
|
-
**`current
|
|
102
|
+
**`current`**—Commits to whatever branch you currently have checked out. Switch branches freely; gitwrit follows you.
|
|
103
103
|
|
|
104
|
-
**`autogenerated
|
|
104
|
+
**`autogenerated`**—Creates a fresh named branch at the start of each session. Branch names are generated by combining a random adjective, noun, and verb—like `crimson-walrus-stumbling` or `teal-fox-bouncing`. 64,000 possible combinations. Good for keeping autosave history separate from your main branch.
|
|
105
105
|
|
|
106
106
|
---
|
|
107
107
|
|
|
@@ -113,16 +113,51 @@ gitwrit checks for updates automatically after every command. If a newer version
|
|
|
113
113
|
· Update available: 0.2.1 → 0.3.0 Run npm install -g gitwrit to update.
|
|
114
114
|
```
|
|
115
115
|
|
|
116
|
-
|
|
117
116
|
The check runs in the background, caches for 24 hours, and fails silently if you are offline. It will never interrupt or slow down your workflow.
|
|
118
117
|
|
|
119
118
|
---
|
|
120
119
|
|
|
120
|
+
## Compatibility
|
|
121
|
+
|
|
122
|
+
| Platform | Status |
|
|
123
|
+
|---|---|
|
|
124
|
+
| macOS | ✅ Fully supported |
|
|
125
|
+
| Linux | ✅ Fully supported |
|
|
126
|
+
| Windows | ❌ Not currently supported |
|
|
127
|
+
|
|
128
|
+
gitwrit is built for macOS and Linux. Windows is not currently supported—the daemon process management and file system watching rely on POSIX signals (`SIGTERM`, `SIGCONT`) that are not available on Windows.
|
|
129
|
+
|
|
130
|
+
If you are a Windows user and would like to contribute Windows support, please open an issue on [GitHub](https://github.com/TBiddy/gitwrit)—it is a welcome contribution.
|
|
131
|
+
|
|
132
|
+
---
|
|
133
|
+
|
|
121
134
|
## Requirements
|
|
122
135
|
|
|
123
136
|
- Node.js ≥ 18
|
|
124
137
|
- Git
|
|
125
|
-
- A configured Git remote (`git remote add origin <url>`)
|
|
138
|
+
- A configured Git remote (`git remote add origin <url>`)—gitwrit requires one before it will initialize a directory
|
|
139
|
+
|
|
140
|
+
---
|
|
141
|
+
|
|
142
|
+
## Troubleshooting
|
|
143
|
+
|
|
144
|
+
**gitwrit isn't committing my changes**
|
|
145
|
+
|
|
146
|
+
gitwrit watches for file save events. Make sure your editor is actually saving to disk—some terminal editors like Pico and Nano require an explicit save (`Ctrl+X` → `Y`) before changes hit the filesystem. gitwrit cannot commit changes that haven't been written to disk yet.
|
|
147
|
+
|
|
148
|
+
**Push failed notification**
|
|
149
|
+
|
|
150
|
+
If gitwrit notifies you that a push failed, first verify that git can push manually from your terminal:
|
|
151
|
+
|
|
152
|
+
```sh
|
|
153
|
+
git push
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
If that works, restart gitwrit with `gitwrit restart`. If it fails, fix your Git authentication first—gitwrit can only push if git itself can push from a non-interactive terminal session. Make sure your SSH key is configured and registered with your Git provider, or that your HTTPS credentials are cached.
|
|
157
|
+
|
|
158
|
+
**Something else feels off**
|
|
159
|
+
|
|
160
|
+
`gitwrit logs` is always your first stop. It shows a timestamped record of every commit, push, and error the daemon has encountered.
|
|
126
161
|
|
|
127
162
|
---
|
|
128
163
|
|