-
-
Notifications
You must be signed in to change notification settings - Fork 0
Home
Joao Palma edited this page Jan 29, 2026
·
6 revisions
DotRun transforms scattered scripts, complex commands, and tribal knowledge into a unified, searchable toolkit that works across all your projects.
Stop hunting for commands. Start running them.
| New User? | Need Help? | Want to Contribute? |
|---|---|---|
| Installation Guide | FAQ | Contributing |
| Quick Start Tutorial | Troubleshooting | Report a Bug |
New to DotRun? Follow this path:
- Installation Guide - One-command setup for Bash, Zsh, and Fish
- Quick Start Tutorial - Your first 5 minutes with DotRun
- User Guide - Complete workflow and core commands
Create, organize, and run scripts from anywhere with dr scriptname.
- Script Management - Creating, organizing, and discovering scripts
-
Documentation System - Self-documenting scripts with
### DOCmarkers
File-based management for shell aliases and environment variables.
- Alias Management - Group related aliases in organized files with load order control
- Configuration Management - Portable environment settings
Share script libraries with your team while maintaining control over updates.
- Collection Management - SHA256 tracking, conflict resolution, and collection authoring
- Team Collaboration - Standards, naming conventions, and workflows
Modular code reuse with the loadHelpers system.
- Helper System - Pattern-based helper loading with 5-level specificity matching
| Action | Scripts | Aliases | Configs | Collections |
|---|---|---|---|---|
| Create/Edit | dr set name |
dr -a name |
dr -c name |
dr -col add <url> |
| List (short) | dr -l |
dr -a list |
dr -c list |
dr -col list |
| List (long) | dr -L |
— | — | — |
| Run | dr name |
(auto-loaded) | (auto-loaded) | (scripts available) |
| Help | dr help name |
dr -a help name |
dr -c help name |
— |
| Move | dr move old new |
dr -a move old new |
dr -c move old new |
— |
| Remove | dr rm name |
dr -a rm name |
dr -c rm name |
dr -col remove name |
- Multi-color display - Folders (yellow), scripts (cyan), commands (green), aliases (purple), configs (red)
-
Recursive search -
dr pattern<TAB>finds ALL matching scripts across nested folders - Full-path matching - Search matches against entire paths, not just filenames
- Lazy-loading - Improved startup performance with on-demand loading
- loadHelpers now works on older macOS systems with Bash 3.2
- Debug logging removed - No disk I/O during tab completion
- Menu completion enforcement - Consistent behavior across all completions
Upgrading from v3.0.0? The upgrade is seamless - just reinstall or pull the latest version.
- Installation → Quick Start → User Guide
- Script Management → Documentation System
- Helper System for advanced modularity
- Team Collaboration Best Practices
- Collection Management → CI/CD Integration
- Browse Workflow Examples
- Quick Reference - Command cheat sheet
- API Reference - Complete command syntax
- FAQ - Common questions and answers
- Troubleshooting - Solutions for common issues
- CHANGELOG - Version history
Real-world workflow templates in the workflows/ directory:
| Workflow | Description |
|---|---|
| DevOps Pipeline | CI/CD automation and infrastructure |
| Full Stack Development | Frontend, backend, and database scripts |
| Data Science Team | ML pipeline and data workflows |
| QA Automation | Testing and quality assurance |
| Startup Development | Rapid prototyping and deployment |
| Team Onboarding | New member setup automation |
| Personal Development | Individual productivity |
Need help? Check the FAQ or Troubleshooting, or open an issue on GitHub.