Open edX Devstack Aliases

Useful bash aliases for the edX devstack. I mainly use them to run tests and paver commands quickly without having to SSH into my devstack.

Warning

The aliases are highly opinionated. If you don't like something you're welcome to submit pull requests and/or fork it!

devstack: Executes a command inside the docker devstack directory.
lms: Execute command as the edxapp user in the lms e.g $ lms ls
studio: Execute command as the edxapp user in the studio e.g $ studio ls
test_bokchoy_one: Tests a single bokchoy test case (requires the --serveronly to be running)
test_system_one: Tests a single lms/cms unit and integration test case e.g. `$ test_system_one lms/djangoapps/appsembler_api/tests/test_views.py
test_cov_system_one: Like test_system_one, with coverage report, and usually slower.

Note: Auto documentation generated from the code using:

$ grep -o 'Doc:.*' -- edx-devstack-aliases | sed -e 's|^Doc: `|- `|'

Clone this repo:

$ git clone https://github.com/OmarIthawi/edx-devstack-aliases.git

Add the following line to your ~/.bashrc file:

source ~/edx-devstack-aliases/edx-devstack-aliases

Close your terminal and open it again!

Exiting long running commands like $ paver lms doesn't work, so it keeps running in the background.

Omar Al-Ithawi (i@omardo.com)