Skip to content

Commit

Permalink
chore(docs): Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
leocavalcante committed Dec 22, 2023
1 parent 68ea26d commit bc89675
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 9 deletions.
17 changes: 11 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,12 +48,17 @@ phpctl sh echo 'Hello, World!' # To run arbitrary sh commands inside the contain
| `server [port] [directory]` | Runs PHP's built-in web-server (default port is `80` and default directory is current `.`). |

### Useful
| Command | Description |
|------------------------------|------------------------------------------------------------------------|
| `sh [commands]` | Starts an interactive Shell session or runs `sh` commands. |
| `repl` | Starts a PHP REPL session (powered by [PsySH](https://psysh.org/)). |
| `fix [arguments]` | Runs PHP CS Fixer on the given directory. |
| `new [template] [directory]` | Creates a new project from a template (`composer create-project`). |
| Command | Description |
|-----------------|---------------------------------------------------------------------|
| `phpunit` | Runs PHPUnit. |
| `sh [commands]` | Starts an interactive Shell session or runs `sh` commands. |
| `repl` | Starts a PHP REPL session (powered by [PsySH](https://psysh.org/)). |
| `php-cs-fixer` | Runs PHP-CS-Fixer. |

### Scaffolders
| Command | Description |
| --- | --- |
| `init-phpunit` | Initializes a PHPUnit configuration. |

### Helpers
| Command | Description |
Expand Down
7 changes: 4 additions & 3 deletions src/help.sh
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,13 @@ help() {
echo -e "\033[0;33mAvailable commands:\033[0m"
echo -e "\033[0;32m php \033[0m Runs PHP commands"
echo -e "\033[0;32m composer \033[0m Runs Composer commands"
echo -e "\033[0;32m at [port] [command] \033[0m Runs commands within a bound port (default port is 80)"
echo -e "\033[0;32m at [port] [command] \033[0m Runs commands within a bound port"
echo -e "\033[0;32m server [port] [directory] \033[0m Runs PHP's built-in web server (default port is 80 and default directory is current .)"
echo -e "\033[0;32m phpunit \033[0m Runs PHPUnit)"
echo -e "\033[0;32m sh [commands] \033[0m Starts an interactive Shell session or runs sh commands"
echo -e "\033[0;32m repl \033[0m Starts a PHP REPL session (powered by PsySH)"
echo -e "\033[0;32m fix [arguments] \033[0m Runs PHP CS Fixer on the given directory."
echo -e "\033[0;32m new [template] [directory] \033[0m Creates a new project from a template (composer create-project)"
echo -e "\033[0;32m php-cs-fixer \033[0m Runs PHP-CS-Fixer"
echo -e "\033[0;32m init-phpunit \033[0m Initializes a PHPUnit configuration"
echo -e "\033[0;32m help or man \033[0m Displays this help message"
echo -e "\033[0;32m doctor \033[0m Inspects the current PHP_VERSION and PHPCTL_IMAGE"
echo -e "\033[0;32m build \033[0m Builds the current Dockerfile (useful for custom images)"
Expand Down

0 comments on commit bc89675

Please sign in to comment.