Skip to main content

Quick Start

Get up and running with projax in just a few minutes.

Step 1: Add Your First Project​

Add a project to the dashboard:

prx add /path/to/your/project

You'll be prompted to:

  1. Enter a custom name (defaults to directory name)
  2. Optionally scan for test files
  3. Automatically scan for ports in configuration files

Or add with a custom name directly:

prx add /path/to/your/project --name "My Awesome Project"

Step 2: List Your Projects​

View all tracked projects:

prx list

This shows a formatted table with:

  • Project ID
  • Name
  • Path
  • Detected ports
  • Number of test files
  • Last scanned timestamp

Step 3: Run a Project​

Run a project's script with intelligent selection:

# Auto-selects dev or start script
prx 1

# Or use the project name
prx "My Awesome Project"

Run a specific script:

prx 1 dev
prx "My Awesome Project" build

Step 4: Run in Background​

Run scripts in the background to keep your terminal free:

prx 1 dev -M

View running processes:

prx ps

Stop a background process:

prx stop <pid>

Step 5: Navigate to Projects​

Quickly change to a project directory:

# Using eval (recommended)
eval "$(prx cd 1)"

# Or get the path
cd $(prx pwd 1)

Step 6: Use the Interactive TUI​

Launch the interactive terminal UI:

prx i
# or
prx prxi

Navigate with arrow keys or vim bindings (j/k), press ? for help.

Step 7: Launch the Desktop App​

Start the Electron-based desktop interface:

prx web

Common Workflows​

Add Multiple Projects​

prx add ~/projects/api-server --name "API Server"
prx add ~/projects/frontend --name "Frontend App"
prx add ~/projects/mobile-app --name "Mobile App"

Scan for Tests and Ports​

# Scan all projects
prx scan

# Scan specific project
prx scan 1
prx scan "My Project"

Run Multiple Projects​

# Start multiple projects in background
prx 1 dev -M
prx 2 dev -M
prx 3 start -M

# Check what's running
prx ps

Handle Port Conflicts​

# Auto-resolve port conflicts
prx 1 dev --force

# Or interactive resolution
prx 1 dev
# Follow the prompts

Shell Integration​

Add this to your ~/.zshrc or ~/.bashrc for easier navigation:

prxcd() {
  eval "$(prx cd $@)"
}

Then use:

prxcd 1
prxcd "My Project"

Next Steps​