Skip to content

feat: add help examples and development scripts#1

Merged
javoire merged 1 commit intomainfrom
stuff
Nov 25, 2025
Merged

feat: add help examples and development scripts#1
javoire merged 1 commit intomainfrom
stuff

Conversation

@javoire
Copy link
Copy Markdown
Owner

@javoire javoire commented Nov 25, 2025

Changes

This PR adds comprehensive help examples and development scripts to improve usability and developer experience.

Help Examples

Added practical examples to all command help outputs:

  • Root command: Common usage patterns for all commands
  • stack new: Branch creation workflow examples
  • stack status: Visual tree output example
  • stack sync: Complete sync workflow with flags

Users can now see real-world usage immediately with --help on any command.

Development Scripts

Added convenience scripts in scripts/ directory:

  • scripts/build - Build the binary
  • scripts/install - Build and symlink to ~/bin (one-command setup!)
  • scripts/test - Run all tests
  • scripts/clean - Clean build artifacts

The install script automatically:

  • Builds the binary
  • Creates ~/bin if needed
  • Symlinks for instant availability
  • Warns if ~/bin not in PATH

Documentation Updates

  • Updated installation instructions to use ./scripts/install
  • Added scripts documentation to Development section
  • Created scripts/README.md with detailed usage

Benefits

  • Easier onboarding: New users see examples immediately
  • Faster development: One-command build and install
  • Better UX: Copy-paste ready examples in help text
  • Cleaner workflow: Scripts handle common tasks

Add comprehensive examples to all command help outputs:
- Root command with common usage patterns
- stack new with branch creation examples
- stack status with tree output example
- stack sync with workflow examples

Add development scripts for easier building and installation:
- scripts/build - Build the binary
- scripts/install - Build and symlink to ~/bin
- scripts/test - Run tests
- scripts/clean - Clean build artifacts

Update README with script documentation and improved installation instructions.
javoire added a commit that referenced this pull request Nov 25, 2025
- Update status command to show full PR URL instead of 'PR #1: OPEN'
- Add stack display after creating new branch with 'stack new'
- Fetch URL field from GitHub PR info
@javoire javoire merged commit 5b64963 into main Nov 25, 2025
@javoire javoire deleted the stuff branch November 27, 2025 18:50
javoire added a commit that referenced this pull request Nov 27, 2025
feat: add help examples and development scripts
javoire added a commit that referenced this pull request Nov 27, 2025
- Update status command to show full PR URL instead of 'PR #1: OPEN'
- Add stack display after creating new branch with 'stack new'
- Fetch URL field from GitHub PR info
javoire pushed a commit that referenced this pull request Nov 27, 2025
### Features

* add help examples and development scripts ([25a6304](25a6304))
* add Homebrew tap setup with GoReleaser ([a3c8d29](a3c8d29))
* add loading spinners for slow operations ([2faeaf0](2faeaf0))
* add prune command with --all flag and skip pushing local-only branches ([ab03859](ab03859))
* add reparent command and improve sync ([5d8a514](5d8a514))
* add stack rename command ([2ff4ed1](2ff4ed1))
* add stack worktree command ([2409143](2409143))
* auto-track stackparent and support base branch arg ([ec53a4b](ec53a4b))
* display stack status tree after sync completion ([afb9154](afb9154))
* enhance status and new commands with better feedback ([c9300d1](c9300d1))
* enhance sync detection, autostash, and merged branch handling ([599d004](599d004))
* handle squash merges with rebase --onto ([f3588c5](f3588c5))
* improve stack display with proper tree structure and PR URLs ([1db69c3](1db69c3))
* initial implementation of stackinator CLI ([b2a8142](b2a8142))
* show PR URL in status and display stack after new ([1c6675b](1c6675b)), closes [#1](#1)

### Performance Improvements

* cache PR data to reduce gh API calls ([db339d7](db339d7))
* optimize stack status performance and add progress spinners ([1e94f29](1e94f29))
* optimize status command and fix stack tree filtering ([63a05d0](63a05d0))
* parallelize network operations for faster sync, status, and prune ([2ac41b1](2ac41b1))
javoire pushed a commit that referenced this pull request Nov 28, 2025
### Features

* add help examples and development scripts ([34c354d](34c354d))
* add Homebrew tap setup with GoReleaser ([afa6ee1](afa6ee1))
* add loading spinners for slow operations ([965c9f4](965c9f4))
* add prune command with --all flag and skip pushing local-only branches ([77f42a6](77f42a6))
* add reparent command and improve sync ([009c47d](009c47d))
* add stack rename command ([0e6623a](0e6623a))
* add stack worktree command ([ea7e088](ea7e088))
* auto-track stackparent and support base branch arg ([36d6863](36d6863))
* display stack status tree after sync completion ([fe7b215](fe7b215))
* enhance status and new commands with better feedback ([7b49661](7b49661))
* enhance sync detection, autostash, and merged branch handling ([99781e9](99781e9))
* handle squash merges with rebase --onto ([2973f86](2973f86))
* improve stack display with proper tree structure and PR URLs ([ea22c43](ea22c43))
* initial implementation of stackinator CLI ([f9f747a](f9f747a))
* show PR URL in status and display stack after new ([03921b7](03921b7)), closes [#1](#1)

### Performance Improvements

* cache PR data to reduce gh API calls ([ff0b068](ff0b068))
* optimize stack status performance and add progress spinners ([b167d86](b167d86))
* optimize status command and fix stack tree filtering ([304f428](304f428))
* parallelize network operations for faster sync, status, and prune ([59669c4](59669c4))
javoire pushed a commit that referenced this pull request Nov 28, 2025
### Features

* add help examples and development scripts ([34c354d](34c354d))
* add Homebrew tap setup with GoReleaser ([afa6ee1](afa6ee1))
* add loading spinners for slow operations ([965c9f4](965c9f4))
* add prune command with --all flag and skip pushing local-only branches ([77f42a6](77f42a6))
* add reparent command and improve sync ([009c47d](009c47d))
* add stack rename command ([0e6623a](0e6623a))
* add stack worktree command ([ea7e088](ea7e088))
* auto-track stackparent and support base branch arg ([36d6863](36d6863))
* display stack status tree after sync completion ([fe7b215](fe7b215))
* enhance status and new commands with better feedback ([7b49661](7b49661))
* enhance sync detection, autostash, and merged branch handling ([99781e9](99781e9))
* handle squash merges with rebase --onto ([2973f86](2973f86))
* improve stack display with proper tree structure and PR URLs ([ea22c43](ea22c43))
* initial implementation of stackinator CLI ([f9f747a](f9f747a))
* prompt to add branch to stack on sync if not tracked ([8a5a2b7](8a5a2b7))
* show PR URL in status and display stack after new ([03921b7](03921b7)), closes [#1](#1)

### Performance Improvements

* cache PR data to reduce gh API calls ([ff0b068](ff0b068))
* optimize stack status performance and add progress spinners ([b167d86](b167d86))
* optimize status command and fix stack tree filtering ([304f428](304f428))
* parallelize network operations for faster sync, status, and prune ([59669c4](59669c4))
javoire pushed a commit that referenced this pull request Nov 28, 2025
### Features

* add help examples and development scripts ([34c354d](34c354d))
* add Homebrew tap setup with GoReleaser ([afa6ee1](afa6ee1))
* add loading spinners for slow operations ([965c9f4](965c9f4))
* add prune command with --all flag and skip pushing local-only branches ([77f42a6](77f42a6))
* add reparent command and improve sync ([009c47d](009c47d))
* add stack rename command ([0e6623a](0e6623a))
* add stack worktree command ([ea7e088](ea7e088))
* auto-track stackparent and support base branch arg ([36d6863](36d6863))
* display stack status tree after sync completion ([fe7b215](fe7b215))
* enhance status and new commands with better feedback ([7b49661](7b49661))
* enhance sync detection, autostash, and merged branch handling ([99781e9](99781e9))
* handle squash merges with rebase --onto ([2973f86](2973f86))
* improve stack display with proper tree structure and PR URLs ([ea22c43](ea22c43))
* initial implementation of stackinator CLI ([f9f747a](f9f747a))
* prompt to add branch to stack on sync if not tracked ([8a5a2b7](8a5a2b7))
* show PR URL in status and display stack after new ([03921b7](03921b7)), closes [#1](#1)

### Bug Fixes

* skip redundant PR base update when already correct ([958d521](958d521))

### Performance Improvements

* cache PR data to reduce gh API calls ([ff0b068](ff0b068))
* optimize stack status performance and add progress spinners ([b167d86](b167d86))
* optimize status command and fix stack tree filtering ([304f428](304f428))
* parallelize network operations for faster sync, status, and prune ([59669c4](59669c4))
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant