Skip to content

docs: point CLI development at getsentry/toolkit #1659

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.

Sign up for GitHub

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
betegon merged 2 commits into from
Oct 7, 2026
Merged

docs: point CLI development at getsentry/toolkit #1659

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
872e4ca
docs: point CLI development at getsentry/toolkit
betegon Oct 7, 2026
54a6728
docs: say the CLI repo will be archived
betegon Oct 7, 2026
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
30 changes: 5 additions & 25 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,27 +1,7 @@
# Sentry Toolkit (pre-shape)
# Sentry CLI

This repository is being reshaped into a pnpm-workspace monorepo ahead of merging
the Sentry CLI and Sentry MCP server into a single `getsentry/toolkit` monorepo.
The Sentry CLI has moved to [`getsentry/toolkit`](https://github.com/getsentry/toolkit).
This repository will be archived. New code, issues, and pull requests belong there.

## Workspace layout

- [`packages/cli/`](./packages/cli) — the Sentry CLI (npm package `sentry`,
binary `sentry`). See [packages/cli/README.md](./packages/cli/README.md).
- [`apps/cli-docs/`](./apps/cli-docs) — the CLI documentation site
(Astro + Starlight, published to `cli.sentry.dev`).

## Development

This is a [pnpm workspace](https://pnpm.io/workspaces). Common tasks are exposed
as delegating scripts at the root and forwarded to the relevant package:

```sh
pnpm install # install all workspace packages
pnpm run build # build the CLI package
pnpm run typecheck # typecheck the CLI package
pnpm run lint # lint
pnpm run test # run the CLI unit tests
```

To work directly within a package, use pnpm filters, e.g.
`pnpm --filter sentry run <script>` or `pnpm --filter sentry-cli-docs run dev`.
- CLI: [`packages/cli`](https://github.com/getsentry/toolkit/tree/main/packages/cli)
- Docs: [`apps/cli-docs`](https://github.com/getsentry/toolkit/tree/main/apps/cli-docs)
8 changes: 6 additions & 2 deletions packages/cli/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@
<a href="https://cli.sentry.dev/commands/">Commands</a>
</p>

> **Moved.** Development continues in [`getsentry/toolkit`](https://github.com/getsentry/toolkit) ([`packages/cli`](https://github.com/getsentry/toolkit/tree/main/packages/cli)). This repository will be archived. New issues, pull requests, and changes go there.

---

## Installation
Expand Down Expand Up @@ -122,6 +124,8 @@ Errors are thrown as `SentryError` with `.exitCode` and `.stderr`.

## Development

New development happens in [`getsentry/toolkit`](https://github.com/getsentry/toolkit).

### Prerequisites

<!-- GENERATED:START dev-prereq -->
Expand All @@ -131,8 +135,8 @@ Errors are thrown as `SentryError` with `.exitCode` and `.stderr`.
### Setup

```bash
git clone https://github.com/getsentry/cli.git
cd cli
git clone https://github.com/getsentry/toolkit.git
cd toolkit
pnpm install
```

Expand Down
Loading