diff --git a/develop-docs/development-infrastructure/devservices.mdx b/develop-docs/development-infrastructure/devservices.mdx index 040af283c82e39..fa318c5786915e 100644 --- a/develop-docs/development-infrastructure/devservices.mdx +++ b/develop-docs/development-infrastructure/devservices.mdx @@ -11,8 +11,8 @@ usage: devservices [-h] [--version] COMMAND ... CLI tool for managing service dependencies. options: - -h, --help show this help message and exit - --version show program's version number and exit + -h, --help show this help message and exit + --version show program's version number and exit commands: up Bring up a service and its dependencies @@ -23,6 +23,7 @@ commands: logs View logs for a service update Update devservices to the latest version purge Purge the local devservices cache + toggle Toggle how a service is run ``` ## Installation @@ -81,6 +82,26 @@ Common modes: devservices up --mode symbolicator ``` +## Running a dependency locally + +If you want to run a dependency locally rather than as a container, you can do so by toggling the runtime to LOCAL. + +For example, if you are running Sentry and want to use your local Snuba, you can do the following: + +```shell +devservices toggle snuba LOCAL +``` + +This will tell devservices to not bring up snuba and its dependencies, allowing you to run snuba locally instead. + +To toggle the runtime back to using the container, you can do the following: + +```shell +devservices toggle snuba CONTAINERIZED +``` + +If you don't provide a runtime when toggling, it will toggle to the opposite of the current runtime. + ## Migrating data from the deprecated `sentry devservices`