@prnv/tuck 1.6.0 → 1.8.0

package/README.md

@@ -13,33 +13,40 @@
 
 [Website](https://tuck.sh) · [Install](#installation) · [Quick Start](#quick-start) · [Commands](#commands)
 
+<img src="public/tuck_preview.png" alt="tuck preview" width="650">
+
 </div>
 
 ---
 
 ## Why tuck?
 
-- **One command to rule them all** — `tuck init` scans your system, lets you pick what to track, and syncs to GitHub
+- **One command to rule them all** — `tuck init` scans your system, lets you pick what to track, and syncs to your remote
+- **Multi-provider support** — GitHub, GitLab (including self-hosted), local-only, or any custom git remote
 - **Smart detection** — Auto-categorizes dotfiles (shell, git, editors, terminal, ssh, etc.)
 - **Beautiful CLI** — Gorgeous prompts, spinners, and progress bars powered by @clack/prompts
 - **Safe by default** — Creates backups before every operation, never overwrites without asking
 - **Git-native** — Uses Git under the hood but hides the complexity
-- **Cross-platform** — Works on macOS and Linux
+- **Cross-platform** — Works on macOS, Linux, and Windows
 
 ## Installation
 
 ```bash
-# npm
+# npm (all platforms)
 npm install -g @prnv/tuck
 
-# Homebrew (macOS/Linux)
-brew install prnv/tap/tuck
+# Homebrew (macOS/Linux) - coming soon
+brew install pranav-karra-3301/tap/tuck
 
-# pnpm
+# pnpm (all platforms)
 pnpm add -g @prnv/tuck
 
-# yarn
+# yarn (all platforms)
 yarn global add @prnv/tuck
+
+# Windows (PowerShell)
+npm install -g @prnv/tuck
+# Or download the binary from GitHub Releases
 ```
 
 ## Quick Start
@@ -53,11 +60,12 @@ tuck init
 
 That's it! `tuck init` does everything:
 
-1. Creates `~/.tuck` repository
-2. Scans your system for dotfiles
-3. Lets you select which to track
-4. Creates a GitHub repo (optional)
-5. Commits and pushes
+1. **Asks where to store** — GitHub, GitLab, local-only, or custom remote
+2. Creates `~/.tuck` repository
+3. Scans your system for dotfiles
+4. Lets you select which to track
+5. Creates a remote repo (if using GitHub/GitLab)
+6. Commits and pushes
 
 ### Ongoing workflow
 
@@ -114,10 +122,11 @@ tuck restore --all
 
 ### Configuration
 
-| Command              | Description                     |
-| -------------------- | ------------------------------- |
-| `tuck config`        | View/edit configuration         |
-| `tuck config wizard` | Interactive configuration setup |
+| Command              | Description                                  |
+| -------------------- | -------------------------------------------- |
+| `tuck config`        | View/edit configuration                      |
+| `tuck config remote` | Configure git provider (GitHub/GitLab/local) |
+| `tuck config wizard` | Interactive configuration setup              |
 
 ## How It Works
 
@@ -146,6 +155,39 @@ tuck stores your dotfiles in `~/.tuck`, organized by category:
 
 Run `tuck sync` anytime to detect changes and push. On a new machine, run `tuck apply username` to grab anyone's dotfiles.
 
+## Git Providers
+
+tuck supports multiple git hosting providers, detected automatically during setup:
+
+| Provider | CLI Required | Features |
+|----------|--------------|----------|
+| **GitHub** | `gh` | Auto-create repos, full integration |
+| **GitLab** | `glab` | Auto-create repos, self-hosted support |
+| **Local** | None | No remote sync, local git only |
+| **Custom** | None | Any git URL (Bitbucket, Gitea, etc.) |
+
+### Switching Providers
+
+```bash
+# Change provider anytime
+tuck config remote
+
+# Or via interactive config menu
+tuck config
+# → Select "Configure remote"
+```
+
+### Self-Hosted GitLab
+
+tuck supports self-hosted GitLab instances:
+
+```bash
+tuck init
+# → Select GitLab
+# → Select "Self-hosted"
+# → Enter your GitLab host (e.g., gitlab.company.com)
+```
+
 ## Configuration
 
 Configure tuck via `~/.tuck/.tuckrc.json` or `tuck config wizard`:
@@ -159,6 +201,10 @@ Configure tuck via `~/.tuck/.tuckrc.json` or `tuck config wizard`:
   "files": {
     "strategy": "copy",
     "backupOnRestore": true
+  },
+  "remote": {
+    "mode": "github",
+    "username": "your-username"
   }
 }
 ```
@@ -168,6 +214,40 @@ Configure tuck via `~/.tuck/.tuckrc.json` or `tuck config wizard`:
 - **copy** (default) — Files are copied. Run `tuck sync` to update the repo.
 - **symlink** — Files are symlinked. Changes are instant but require more care.
 
+## Windows Support
+
+tuck fully supports Windows with platform-specific handling:
+
+### Detected Windows Dotfiles
+
+| Category | Files |
+|----------|-------|
+| **Shell** | PowerShell profiles (`Microsoft.PowerShell_profile.ps1`) |
+| **Terminal** | Windows Terminal settings, ConEmu/Cmder configs |
+| **Editors** | VS Code, Cursor, Neovim (in `%LOCALAPPDATA%`) |
+| **Git** | `.gitconfig`, `.gitignore_global` |
+| **SSH** | SSH config in `%USERPROFILE%\.ssh` |
+| **Misc** | WSL config (`.wslconfig`), Docker, Kubernetes |
+
+### Windows-Specific Behavior
+
+- **Symlinks**: On Windows, tuck uses directory junctions (don't require admin privileges) or falls back to copying files
+- **Permissions**: Unix-style file permissions (chmod) don't apply on Windows; tuck handles this gracefully
+- **Paths**: Windows environment variables (`%APPDATA%`, `%LOCALAPPDATA%`, `%USERPROFILE%`) are automatically expanded
+- **Hooks**: tuck uses PowerShell Core (`pwsh`) or Windows PowerShell for hook execution
+
+### PowerShell Profile Merging
+
+tuck supports smart merging for PowerShell profiles with preserve markers:
+
+```powershell
+# In your PowerShell profile, mark local-only sections:
+<# tuck:preserve #>
+# Machine-specific aliases
+Set-Alias code "C:\Program Files\Microsoft VS Code\Code.exe"
+<# /tuck:preserve #>
+```
+
 ## Security
 
 tuck is designed with security in mind: