gdx 0.1.1 → 0.2.0

package/README.md

@@ -5,7 +5,7 @@
 ![License](https://img.shields.io/badge/license-MIT-blue.svg) ![Status](https://img.shields.io/badge/status-experimental-orange.svg)
 
 > [!WARNING]
-> **⚠️ PRE-ALPHA WARNING:** This project is currently in a "trial phase" (i.e., I'm dogfooding it daily). Expect breaking changes, missing features, and the occasional hiccup.
+> **⚠️ ALPHA WARNING:** This project is currently in a "trial phase" (i.e., I'm dogfooding it daily). Expect breaking changes, missing features, and the occasional hiccup.
 
 ---
 
@@ -81,15 +81,21 @@ bun install
 bun run build
 ```
 
-Your compiled binary will be in `./dist/gdx` (or `./dist/gdx.exe` on Windows).
+Your compiled binary will be in `./dist/` folder.
 
 </details>
 
 ### Optional: Shell Integration
 
-To enable features like `gdx parallel switch` (auto-cd into worktrees), you need to add shell integration.
+To enable features like `gdx parallel switch` (auto-cd into worktrees) and **tab completion**, you need to add shell integration.
 
-To do this add the following line to the **End** of your shell profile (`~/.bashrc`, `~/.zshrc`, etc.):
+Shell integration provides:
+
+- **Auto-cd support**: Allows `gdx parallel switch` to change directories
+- **Tab completion**: Intelligent completion for gdx commands, shorthands, and git subcommands
+- **Git fallback**: Falls back to native git completion when gdx has no suggestions (git fallback requires you to install git's completion scripts separately)
+
+To add shell integration, add the following line to the **End** of your shell profile (`~/.bashrc`, `~/.zshrc`, etc.):
 
 #### For bash and zsh:
 
@@ -112,6 +118,10 @@ To find your profile path, run `$PROFILE` in PowerShell.
 Invoke-Expression (& { (gdx --init --shell pwsh | Out-String) })
 ```
 
+> [!TIP]
+> You can add `--cmd` to the `gdx --init` command to create custom aliases.
+> For example, `gdx --init --shell zsh --cmd g` will create `g` as an alias for `gdx`.
+
 ## Core Features
 
 ### 1. Intelligent Shorthands
@@ -169,6 +179,7 @@ Git stash is great until you need to clean it up.
 gdx sta l           # git stash list
 gdx sta d 2..6      # Drops stashes 2 through 6.
                     # (Drops high->low to prevent index shifting)
+gdx sta d pardon    # Restores the last dropped stash.
 ```
 
 ### 6. AI-Powered Commits
@@ -231,7 +242,7 @@ This project uses **Bun** for development because it's fast and the developer ex
 Since this is currently a solo "scratch your own itch" project, the roadmap is fluid, but here is what is on the horizon:
 
 - [x] **Configurability:** Allow users to define their own shorthands in a `.gdxrc.toml` file.
-- [ ] **Shell Integration:** Auto-completion scripts for Zsh/Bash/Fish/Powershell.
+- [x] **Shell Integration:** Auto-completion scripts for Zsh/Bash/Fish/Powershell with git fallback.
 - [ ] **Commit with specified editor:** like, `gdx commit --vim` to open Vim for commit messages.
 - [ ] **Quick commit:** `add`, `commit`, and `push` in one command like `gdx qc -pa` (`git add . && gdx commit auto && git push`)
 - [x] **Quick linting before push:** `gdx lint` to run following checks before pushing:
@@ -240,13 +251,13 @@ Since this is currently a solo "scratch your own itch" project, the roadmap is f
    - conflict markers
    - abnormal file sizes
      with an option to automatically run lint before every push (bypass with `gdx push --no-lint`)
-- [ ] **Undoable stash drop**
+- [x] **Undoable stash drop**
 - [x] **Parallel worktree switching** `gdx parallel switch` Jump between forks (auto-cd) (requires shell integration with `gdx --init --shell`)
 - [ ] **Seamless Integration with fzf and cloc**
       automatically detect and use fzf and/or cloc if installed for:
    - Interactive fuzzy search for branches, commits, stash, log and files instead of `less`
    - Code line statistics in `gdx stats` using `cloc`
-- [ ] **gdx clear Untracked files support**: `gdx clear` currently only saves changes to tracked files. Add an option to back up untracked files as well.
+- [x] **gdx clear Untracked files support**: `gdx clear` now automatically backs up untracked files in the patch.
 - [ ] **gdx migrate**: move dirty changes to another branch/worktree without committing.
 
 ## License