Skip to content

INSTALL.md

Latest commit

 

History

History
193 lines (136 loc) · 3.66 KB

INSTALL.md

File metadata and controls

193 lines (136 loc) · 3.66 KB

DevRun Installation Guide

🌍 Global Installation (Recommended)

DevRun is designed to be installed globally so you can use it in any project directory on your system.

Method 1: Install from PyPI (When Available)

# Install globally from PyPI
pip install devrun

# Verify installation
devrun help

Method 2: Install from Source

# Clone the repository
git clone https://github.com/devrun/devrun.git
cd devrun

# Install globally
pip install .

# Verify installation
devrun help

Method 3: Using Make (Recommended for Development)

# Clone and install in one step
git clone https://github.com/devrun/devrun.git
cd devrun
make install

# This runs: pip install .

✅ Verify Installation

After installation, verify DevRun is working:

# Check if devrun command is available
devrun help

# Check version
devrun --version  # (if implemented)

# Test in any directory
cd ~/Desktop
devrun status  # Should show "No supported project detected"

🚀 Using DevRun Globally

Once installed globally, you can use DevRun in any project:

# Node.js project
cd ~/my-react-app
devrun start  # Automatically detects and runs with npm

# Python project  
cd ~/my-flask-api
devrun start  # Automatically detects and runs with python

# Go project
cd ~/my-go-service  
devrun start  # Automatically detects and runs with go

# Java project
cd ~/my-spring-boot-app
devrun start  # Automatically detects and runs with maven/gradle

🔧 Development Installation

If you want to contribute to DevRun or modify it:

# Clone repository
git clone https://github.com/devrun/devrun.git
cd devrun

# Install in development mode (changes reflect immediately)
pip install -e .

# Or use make
make install-dev

🐍 Python Requirements

  • Python 3.7+ (DevRun uses only standard library)
  • pip for installation
  • No external dependencies required

🛠️ Troubleshooting

Command Not Found

If devrun command is not found after installation:

# Check if pip installed to the right location
pip show devrun

# Check your PATH includes pip's bin directory
echo $PATH

# On some systems, you might need:
python -m pip install devrun

# Or use pip3 explicitly:
pip3 install devrun

Permission Issues

If you get permission errors:

# Install with user flag (installs to ~/.local/bin)
pip install --user devrun

# Make sure ~/.local/bin is in your PATH
export PATH="$HOME/.local/bin:$PATH"

# Add to your shell profile (.bashrc, .zshrc, etc.)
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc

Virtual Environment Issues

DevRun should be installed globally, not in a virtual environment:

# Deactivate any virtual environment first
deactivate

# Then install globally
pip install devrun

🔄 Updating DevRun

To update to the latest version:

# Update from PyPI
pip install --upgrade devrun

# Or reinstall from source
git pull origin main
pip install --upgrade .

🗑️ Uninstalling

To remove DevRun:

pip uninstall devrun

💡 Pro Tips

  1. Add to Shell Aliases: Create shortcuts for common workflows

    # Add to ~/.bashrc or ~/.zshrc
alias dr="devrun start"
alias drs="devrun status"

  2. Use in CI/CD: DevRun can help catch errors in automated testing

    # In your CI script
devrun start &  # Run in background
# Run your tests
# DevRun will catch and explain any runtime errors

  3. Team Setup: Share DevRun installation in your team's setup docs

    # Add to your project's README.md
## Development Setup
1. Install DevRun: `pip install devrun`
2. Start development: `devrun start`