Skip to content

docs: Add pdsh compatibility mode documentation and installation scripts #110

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
inureyes merged 2 commits into from
Dec 17, 2025
Merged

docs: Add pdsh compatibility mode documentation and installation scripts #110

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
18cdef8
docs: Add pdsh compatibility mode documentation and installation scripts
inureyes Dec 17, 2025
70b1fbe
fix: Address PR review issues
inureyes Dec 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -395,12 +395,17 @@ bssh -H nodes --batch --stream "deployment-script.sh"

bssh supports pdsh compatibility mode, enabling it to act as a drop-in replacement for pdsh. This allows seamless migration from pdsh without modifying existing scripts.

**📖 Complete Documentation**:
- **[Migration Guide](docs/pdsh-migration.md)** - Step-by-step migration from pdsh to bssh
- **[Options Reference](docs/pdsh-options.md)** - Complete option mapping table
- **[Examples](docs/pdsh-examples.md)** - Real-world usage patterns

#### Activation Methods

**1. Binary symlink** (recommended for full compatibility):
```bash
# Create symlink
sudo ln -s /usr/bin/bssh /usr/local/bin/pdsh
# Create symlink (done automatically by Homebrew)
sudo ln -sf "$(which bssh)" /usr/local/bin/pdsh

# Now pdsh commands use bssh
pdsh -w host1,host2 "uptime"
Expand All @@ -416,6 +421,12 @@ BSSH_PDSH_COMPAT=1 bssh -w host1,host2 "uptime"
bssh --pdsh-compat -w host1,host2 "uptime"
```

**4. Shell alias**:
```bash
# Add to ~/.bashrc or ~/.zshrc
alias pdsh='bssh --pdsh-compat'
```

#### pdsh Option Mapping

| pdsh option | bssh equivalent | Description |
Expand Down
Loading