easyengine/shell-command

Shell to run helpful commands inside containers.

easyengine/shell-command

Shell to run helpful commands inside containers., _(*1)

Quick links: Using | Contributing | Support, _(*2)

Using

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

OPTIONS, _(*3)

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

[--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, _(*4)

# 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., _(*5)

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., _(*6)

Reporting a bug

Think you’ve found a bug? We’d love for you to help us get it fixed., _(*7)

Before you create a new issue, you should search existing issues to see if there’s an existing resolution to it, or if it’s already been fixed in a newer version., _(*8)

Once you’ve done a bit of searching and discovered there isn’t an open or fixed issue for your bug, please create a new issue. Include as much detail as you can, and clear steps to reproduce if possible., _(*9)

Creating a pull request

Want to contribute a new feature? Please first open a new issue to discuss whether the feature is a good fit for the project., _(*10)

Support

Github issues aren't for general support questions, but there are other venues you can try: https://easyengine.io/support/, _(*11)

This README.md is generated dynamically from the project's codebase using ee scaffold package-readme (doc). To suggest changes, please submit a pull request against the corresponding part of the codebase., _(*12)