Skip to content

feat(toggle): Adding docs for the toggle command #13487

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 25, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 23 additions & 2 deletions develop-docs/development-infrastructure/devservices.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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`

<Alert level="warning" title="Important">
Expand Down