diff --git a/README.md b/README.md index e6ed90a..6a647ba 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ Quick links: [Using](#using) | [Contributing](#contributing) | [Support](#suppor ## Using ~~~ -ee shell [] +ee shell [] [--user=] [--service=] [--command=] [--skip-tty] ~~~ **OPTIONS** @@ -18,18 +18,41 @@ ee shell [] [] Name of website to run shell on. -**EXAMPLES** + [--user=] + Set the user to exec into shell. + + [--service=] + Set the service whose shell you want. + --- + default: php + --- + + [--command=] + Command to non-interactively run in the shell. + + [--skip-tty] + Skips tty allocation. + + **EXAMPLES** # Open shell for site $ ee shell example.com + # Open shell with root user + $ ee shell example.com --user=root + + # Open shell for some other service + $ ee shell example.com --service=nginx + + # Run command non-interactively + $ ee shell example.com --service=nginx --command='nginx -t && nginx -s reload' + ## Contributing We appreciate you taking the initiative to contribute to this project. Contributing isn’t limited to just code. We encourage you to contribute in the way that best fits your abilities, by writing tutorials, giving a demo at your local meetup, helping other users with their support questions, or revising our documentation. - ### Reporting a bug Think you’ve found a bug? We’d love for you to help us get it fixed.