Get started with DDEV-Live¶
You will need¶
- GitHub account
Grant DDEV-Live access to your selected repositories.
1. In your browser, navigate to https://dash.ddev.com.
2. If prompted, click the Login With Github button and log in to GitHub if needed. The DDEV-Live UI displays.
3. In the Important Links section on the dash homepage, click the Install Github App link. A GitHub configuration page displays.
4. Choose the personal or organization account where you want to install the app, then select the repositories you want DDEV-Live to access and click Install. You or the organization must own the repositories.
You can change these settings and add or remove repositories later in Settings.
Install the DDEV-Live CLI¶
You can install the DDEV-Live CLI with Homebrew
$ brew tap drud/ddev-live $ brew install drud/ddev-live/ddev-live
Alternative Mac and Linux install¶
From the DDEV-Live dashboard, click the Authenticate via CLI link for your operating system to download the DDEV-Live CLI. This will download a file named ddev-live.zip.
- Extract ddev-live.zip. For example:
- Move the resulting ddev-live binary to a directory that is in your $PATH variable. For example:
mv ~/Downloads/ddev-live /usr/local/bin. You may need to add to your
$PATHin your .bash_profile or equivalent.
From the DDEV-Live dashboard, click the Authenticate via CLI link for Windows to download the DDEV-Live CLI. This will download a file named ddev-live.zip.
- Extract ddev-live.zip to a directory that is in your %PATH% variable. For example, extract to:
C:\Program Files. You may need to edit and add to the Path environment variable in Advanced System Properties.
Verify installation and authenticate¶
Authentication connects the DDEV-Live platform to the DDEV-Live CLI.
- In your terminal window, type
ddev-live. Successful installation will return usage information. Run
ddev-live [command] -hat any time for details on commands.
ddev-live auth. A browser window opens the DDEV-Live dashboard displaying a confirmation message.
The CLI displays
Authentication complete!. If you are primarily working with one organization you may want to run ddev-live auth --default-org
to refer to sites only using instead of / and eliminate needing to use the --org flag for subsequent commands.