diff --git a/README.md b/README.md index eb7c189..e72f3df 100644 --- a/README.md +++ b/README.md @@ -82,7 +82,15 @@ Easy as that! ## Command line utilities -Investbrain comes bundled with several helpful command line utilities to make managing your portfolios and holdings more efficient. Keep in mind these commands are extremely powerful and can make irreversable changes to your holdings. We only recommend backing up your portfolios before using these commands: +Investbrain comes bundled with several helpful command line utilities to make managing your portfolios and holdings more efficient. Keep in mind these commands are extremely powerful and can make irreversable changes to your holdings. + +To run these commands, you can use `docker exec` like this: + +```bash +docker exec -it investbrain-app php artisan +``` + +Just to be safe, we recommend backing up your portfolios before using these commands: | Command | Description | | ------------- | ------------- | @@ -93,12 +101,6 @@ Investbrain comes bundled with several helpful command line utilities to make ma | sync:daily-change | Re-calculates daily snapshots of your portfolio's daily performance. | | sync:holdings | Re-calculates performance of holdings with related transactions (i.e. dividends, realized gains, etc). | -To run these commands, you can use `docker exec` like this: - -```bash -docker exec -it investbrain-app php artisan -``` - ## Testing Investbrain has a complete PHPUnit test suite that creates an in-memory SQLite database and runs any queued jobs synchronously using Laravel's array driver. You can run the entire Investbrain test suite from within the Docker container by running: