Skip to main content
Shell aliases let you start psys with a single command from anywhere in your terminal.

​
Quick Setup

Create a psys alias to start the application in background mode with one command.
1

Build the application

Run the build command at least once:
2

Add alias to shell configuration

Open your shell configuration file and add the alias.
Replace /path/to/psys with the actual absolute path to your psys project directory.
3

Reload shell configuration

Apply the changes by reloading your shell configuration:
4

Run the alias

Now you can start psys from anywhere:
The app starts in the background on port 30999.

​
Shell Configuration Files

Choose the correct configuration file based on your shell:
Not sure which shell you’re using? Run echo $SHELL in your terminal.

​
Example: Finding Your Project Path

To get the absolute path for the alias:
1

Navigate to the project

2

Get the full path

Output example: /home/username/projects/psys
3

Use in alias

​
Advanced Aliases

You can create additional aliases for different operations:
The open command works on macOS. On Linux, use xdg-open instead.

​
Verifying the Alias

After setting up your alias:
1

Check the alias definition

This displays the alias definition to verify it’s correct.
2

Test the alias

The application should start in the background.
3

Verify it's running

Open http://localhost:30999 or check with:

​
Troubleshooting

Make sure you reloaded the shell configuration:
Or open a new terminal window.
Ensure Node.js and npm are installed and in your PATH:
Run the build command first:
The production build must exist before using npm run start:bg.
Another instance might be running. Stop it first:
Or use lsof -ti:30999 | xargs kill to kill the process using that port.