@gw-tools/gw 0.56.5 → 0.57.0-beta.56.2

package/README.md

@@ -334,15 +334,26 @@ cp dist/packages/gw-tool/gw /usr/local/bin/gw
 
 On first run, `gw` will automatically detect your git repository root and create a configuration file at `.gw/config.json`. The tool finds the config by walking up the directory tree from your current location, so you can run `gw` commands from anywhere within your repository.
 
+**The `.gw/config.json` file is safe to commit to your repository.** It contains only portable settings — no machine-specific paths or runtime state. The `root` field has been removed; gw auto-detects the repository root from the config file location. Runtime state like cleanup timestamps is managed internally and never written to the config file.
+
 ### Auto-Detection
 
 The tool automatically:
 
 1. **Searches for existing config**: Walks up from your current directory looking for `.gw/config.json`
-2. **Auto-detects git root**: If no config is found, detects the repository root automatically
-3. **Creates config**: Saves the detected root and default settings to `.gw/config.json`
+2. **Auto-detects git root**: Derives the git root from the config file's location (or detects it if no config exists)
+3. **Creates config**: Saves default settings to `.gw/config.json` in your worktree root
 
-If auto-detection fails (rare edge cases), you can manually initialize:
+Config is created inside the current worktree so it can be committed to git and shared with your team. This means everyone gets the same `autoCopyFiles`, `hooks`, `defaultBranch`, etc. without each person having to configure it.
+
+```bash
+# Initialize and commit (one-time, from any worktree)
+gw init --auto-copy-files .env --post-checkout "pnpm install"
+git add .gw/config.json
+git commit -m "chore: share gw config"
+```
+
+If auto-detection fails (rare edge cases), you can manually specify the root:
 
 ```bash
 gw init --root /path/to/your/repo.git
@@ -352,7 +363,6 @@ gw init --root /path/to/your/repo.git
 
 ```jsonc
 {
-  "root": "/Users/username/Workspace/my-project.git",
   "defaultBranch": "main",
   // Auto-copy these files when creating new worktrees
   "autoCopyFiles": [".env", "components/agents/.env", "components/ui/.vercel/"],
@@ -365,7 +375,6 @@ gw init --root /path/to/your/repo.git
   "cleanThreshold": 7,
   "autoClean": true,
   "updateStrategy": "merge",
-  "lastAutoCleanTime": 1706371200000, // trailing comma OK
 }
 ```
 
@@ -375,16 +384,16 @@ gw init --root /path/to/your/repo.git
 
 ### Configuration Options
 
-- **root**: Absolute path to the git repository root (automatically detected or manually set with `gw init`)
-- **defaultBranch**: Default source worktree name (optional, defaults to "main")
-- **autoCopyFiles**: Array of file/directory paths to automatically copy when creating worktrees with `gw checkout` (optional, only set via `gw init --auto-copy-files`)
-- **hooks**: Command hooks configuration (optional, set via `gw init --pre-checkout` and `--post-checkout`)
+All fields are optional and safe to commit — no machine-specific paths or runtime state is stored.
+
+- **defaultBranch**: Default source worktree name (defaults to "main")
+- **autoCopyFiles**: Array of file/directory paths to automatically copy when creating worktrees with `gw checkout` (set via `gw init --auto-copy-files`)
+- **hooks**: Command hooks configuration (set via `gw init --pre-checkout` and `--post-checkout`)
   - **hooks.checkout.pre**: Array of commands to run before creating a worktree
   - **hooks.checkout.post**: Array of commands to run after creating a worktree
-- **cleanThreshold**: Number of days before worktrees are considered stale for `gw clean` (optional, defaults to 7, set via `gw init --clean-threshold`)
-- **autoClean**: Silently remove stale worktrees in the background when running `gw checkout` or `gw list` (optional, defaults to false, set via `gw init --auto-clean`)
-- **updateStrategy**: Default strategy for `gw update` command: "merge" or "rebase" (optional, defaults to "merge", set via `gw init --update-strategy`)
-- **lastAutoCleanTime**: Internal timestamp tracking last auto-cleanup run (managed automatically, do not edit manually)
+- **cleanThreshold**: Number of days before worktrees are considered stale for `gw clean` (defaults to 7, set via `gw init --clean-threshold`)
+- **autoClean**: Silently remove stale worktrees in the background when running `gw checkout` or `gw list` (defaults to false, set via `gw init --auto-clean`)
+- **updateStrategy**: Default strategy for `gw update` command: "merge" or "rebase" (defaults to "merge", set via `gw init --update-strategy`)
 
 ## Commands
 
@@ -560,7 +569,6 @@ This creates:
 
 ```json
 {
-  "root": "/path/to/repo.git",
   "defaultBranch": "main",
   "autoCopyFiles": [".env", "secrets/", "components/ui/.vercel/"]
 }
@@ -1151,7 +1159,6 @@ If your `.gw/config.json` contains:
 
 ```json
 {
-  "root": "/Users/username/Workspace/repo.git",
   "defaultBranch": "main",
   "autoCopyFiles": [".env", "secrets/"],
   "hooks": {
@@ -1547,6 +1554,10 @@ gw cd feat/new-feature
 gw init --auto-copy-files .env,components/agents/.env,components/ui/.vercel/ \
   --post-checkout "pnpm install"
 
+# Commit the config so your team gets the same setup
+git add .gw/config.json
+git commit -m "chore: share gw config"
+
 # From within any worktree of your repository
 # Create a new worktree with auto-copy and hooks
 gw add feat/new-feature

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gw-tools/gw",
-  "version": "0.56.5",
+  "version": "0.57.0-beta.56.2",
   "description": "A command-line tool for managing git worktrees - copy files between worktrees with ease",
   "keywords": [
     "git",