Overview of all commands¶
Global commands¶
launchpad¶
Global Help
launchpad controlcenter¶
Help for controlcenter command and subcommands
launchpad project¶
Help for project command and subcommands
launchpad prune¶
Deletes all projects, project information and controlcenter data from your system
launchpad version¶
Shows version info
Controlcenter commands¶
launchpad controlcenter status¶
Gets the status and basic info of the local controlcenter
launchpad controlcenter start¶
Initialize and start the local controlcenter
flags:
--http-port
: The port to use for http requests (default 81)--https-port
: The port to use for https requests (default 444)--tld
: The frontend TLD to use (default "localhost")--project-prefix
: The project prefix to use (default "docker")--controlcenter-name
: The domain name of the controlcenter (default "controlcenter")--project-folder
: The folder where all projects are stored (default "<homedir>/.dropsolid_launchpad/projects")
launchpad controlcenter stop¶
Stops all the (running) projects and the controlcenter
flags:
--clean
: Clean the Docker-sync containers of the projects (only useful on MacOS)--force
: Force stopped projects to be stopped and cleaned up
launchpad controlcenter install_ca¶
Installs a custom CA certificate to enable usage of valid SSL certificates for local sites.
launchpad controlcenter enable_nfs¶
Enables NFS mounts for launchpad projects (MacOS only)
This is the only Launchpad command you have to run as admin user (e.g. with sudo
)
launchpad controlcenter generate_cert [DOMAIN_NAME]¶
Generates a certificate for a domain name
arguments:
DOMAIN_NAME
: The domain name to generate the certificate for.
Format is subdomain.domain.tld (nohttp://
or trailing/
)
launchpad controlcenter add_ssh_key [SSH_KEY_PATH]¶
Add an SSH private key to the controlcenter
arguments:
SSH_KEY_PATH
: The path to a local SSH private key.
launchpad controlcenter cache_clear¶
clear the local cache of the Dropsolid Platform data
Do not execute this with custom projects
If you configured custom projects, the config files of those projects will be deleted too.
Project commands¶
launchpad project info [PROJECT_NAME]¶
Fetches all the known project info from Dropsolid Platform and the controlcenter
arguments:
PROJECT_NAME
: The machine name of the project to get the info for.
flags:
--refresh
: Refresh the project data from the external source
launchpad project get [PROJECT_NAME]¶
Fetches the necessary project info from Dropsolid Platform, clones the repo, starts the project, and syncs files and db
arguments:
PROJECT_NAME
: The machine name of the project to be fetched.
flags:
--branch
: branch to checkout (default "master")--shallow
: do a shallow clone (single branch and no history)--env
: environment to sync from (default "staging")--sync_files
: Sync files instead of using stage file proxy--php_version
: PHP version (5.6, 7.1, 7.2 or 7.3) to use, defaults to the version of the project--solr
: Add solr to the project stack--solr_version
: Solr version (5.5 or 6.6) to use, defaults to the version of the project--varnish
: Add varnish to the project stack--memcached
: Add memcached to the project stack--xhprof
: Add XHProf to the project stack--ngrok
: Add Ngrok to the project stack--https
: Enable HTTPS urls for the project--sync_strategy
: Define sync strategy (nfs, docker-sync, none) to use, defaults to nfs (only useful on MacOS)--docroot_folder
: Define the folder used as document root in the Apache and shell containers, defaults to docroot.
This folder must be relative to the project root
launchpad project clone [PROJECT_NAME]¶
Fetches the necessary project info from Dropsolid Platform, and clones the repo
arguments:
PROJECT_NAME
: The machine name of the project to clone.
flags:
--branch
: branch to checkout (default "master")--shallow
: do a shallow clone (single branch and no history)
launchpad project start [PROJECT_NAME]¶
Bootstraps the docker config into a cloned project and starts it up
arguments:
PROJECT_NAME
: The machine name of the project to start.
flags:
--php_version
: PHP version (5.6, 7.1, 7.2 or 7.3) to use, defaults to the version of the project--solr
: Add solr to the project stack--solr_version
: Solr version (5.5 or 6.6) to use, defaults to the version of the project--varnish
: Add varnish to the project stack--memcached
: Add memcached to the project stack--xhprof
: Add XHProf to the project stack--ngrok
: Add Ngrok to the project stack--https
: Enable HTTPS urls for the project--sync_strategy
: Define sync strategy (nfs, docker-sync, none) to use, defaults to nfs (only useful on MacOS)--docroot_folder
: Define the folder used as document root in the Apache and shell containers, defaults to docroot.
This folder must be relative to the project root
launchpad project sync [PROJECT_NAME]¶
Syncs the db and files from a project
arguments:
PROJECT_NAME
: The machine name of the project to sync.
flags:
--env
: environment to sync from (default "staging")--sync_files
: Sync files instead of using stage file proxy
launchpad project stop [PROJECT_NAME]¶
Stops the docker stack of a project
arguments:
PROJECT_NAME
: The machine name of the project to stop.
flags:
--clean
: Clean the Docker-sync containers (only useful on MacOS)--force
: Force the project to be stopped and cleaned up
launchpad project remove [PROJECT_NAME]¶
Removes a project completely
arguments:
PROJECT_NAME
: The machine name of the project to remove.
launchpad project open [PROJECT_NAME]¶
Opens a link to the project
arguments:
PROJECT_NAME
: The project machine name to interact with.
launchpad project uli [PROJECT_NAME]¶
Creates a one time login link for the project and opens it in the browser
arguments:
PROJECT_NAME
: The machine name of the project to login to.
launchpad project shell [PROJECT_NAME]¶
Opens a shell for the project
arguments:
PROJECT_NAME
: The machine name of the project to start a shell.
launchpad project pma [PROJECT_NAME]¶
Opens a PhpMyAdmin session for the project and opens it in the browser
arguments:
PROJECT_NAME
: The machine name of the project to open a PMA session in a browser.
launchpad project db [PROJECT_NAME]¶
Opens a db connection for the project in Sequel Pro / Sequel Ace (MacOS only)
arguments:
PROJECT_NAME
: The machine name of the project to open a Sequel Pro session.
flags:
--db_container
: the name of the db container (defaults todb
).
launchpad project toggle_xdebug [PROJECT_NAME]¶
Toggles xdebug for a managed project
arguments:
PROJECT_NAME
: The machine name of the project to toggle xdebug