Skip to content

Commit

Permalink
Merge branch 'develop' for v1.0.2
Browse files Browse the repository at this point in the history
  • Loading branch information
mrrobot47 committed Dec 28, 2018
2 parents 06bb4b7 + a3e7efc commit e6dd5ac
Showing 1 changed file with 26 additions and 3 deletions.
29 changes: 26 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,26 +10,49 @@ Quick links: [Using](#using) | [Contributing](#contributing) | [Support](#suppor
## Using

~~~
ee shell [<site-name>]
ee shell [<site-name>] [--user=<user>] [--service=<service>] [--command=<command>] [--skip-tty]
~~~

**OPTIONS**

[<site-name>]
Name of website to run shell on.

**EXAMPLES**
[--user=<user>]
Set the user to exec into shell.

[--service=<service>]
Set the service whose shell you want.
---
default: php
---

[--command=<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.
Expand Down

0 comments on commit e6dd5ac

Please sign in to comment.