Skip to content

README.md

Latest commit

 

History

History
55 lines (40 loc) · 1.72 KB

README.md

File metadata and controls

55 lines (40 loc) · 1.72 KB

Whisp template project

Use this template project to get started in <60 seconds with Whisp, the pure PHP SSH server for PHP based TUIs.

⇾ Learn more about Whisp

What's included

This template sets you up with the Whisp server, example TUI apps, and Laravel Prompts.

Files

  • whisp-server.php - Runs the SSH server on port 2020, ./whisp-server.php
  • apps/ - Holds our apps
    • default.php - Called when no app is specifically requested
    • howdy-[name].php - Basic script to show how simple things can be, supports params
    • prompts.php - More complex Laravel Prompts setup to show what's supported
    • confetti.php - Draws confetti without Laravel Prompts
    • clipboard.php - Laravel Prompts app demoing copying to the user's clipboard

Testing

Composer install, run the server, then SSH to each app:

Run the server

php whisp-server.php

Run the howdy app

ssh howdy-dood@localhost -p2020

Run the prompts app We don't need to pass the app or script name here as it's the default

ssh localhost -p2020

Run the confetti app We can also call apps using -t appName

ssh localhost -p2020 -t confetti

Hosting

Read the full docs or use the files in the systemd dir to run your server 24x7.

Support & Credits

This was developed by Ashley Hindle. If you like it, please star it, share it, and let me know!