docs: remove experimental status from CLI and promote it in README (#3273)

## Changes

- Remove the "experimental" label from `docs/cli.md`.
- Add a **CLI** section to the README with a short usage example.
- Add a **CLI** link to the README link bar.
- Remove the `--slim` config example from "Getting started".
- Add one sentence about `--slim` to the "Configuration" section.

This PR changes documentation only. It does not change tool behavior.
This commit is contained in:
Alex Rudenko authored and GitHub committed 2026-10-21 12:16:29 +00:00
1 parent 8b119d9cfe
commit 0ced16b960
2 files changed
+21 -21

No files matched your search

+20 -20
View File
@@ -3,12 +3,12 @@
[![npm chrome-devtools-mcp package](https://img.shields.io/npm/v/chrome-devtools-mcp.svg)](https://npmjs.org/package/chrome-devtools-mcp)
Chrome DevTools for agents (`chrome-devtools-mcp`) lets your coding agent (such as Antigravity, Claude, Cursor or Copilot)
control and inspect a live Chrome browser. It acts as a Model-Context-Protocol
(MCP) server, giving your AI coding assistant access to the full power of
Chrome DevTools for reliable automation, in-depth debugging, and performance analysis.
A [CLI][cli] is also provided for use without MCP.
control and inspect a live Chrome browser. It is available as a
Model-Context-Protocol (MCP) server and as a [CLI][cli]. Both give your AI
coding assistant access to the full power of Chrome DevTools for reliable
automation, in-depth debugging, and performance analysis.
[Tool reference][tool-reference] | [Changelog][changelog] | [Contributing][contributing] | [Troubleshooting][troubleshooting] | [Design Principles][design-principles]
[Tool reference][tool-reference] | [CLI][cli] | [Changelog][changelog] | [Contributing][contributing] | [Troubleshooting][troubleshooting] | [Design Principles][design-principles]
## Key features
@@ -83,21 +83,6 @@ Add the following config to your MCP client:
> [!NOTE]
> Using `chrome-devtools-mcp@latest` ensures that your MCP client will always use the latest version of the Chrome DevTools MCP server.
If you are interested in doing only basic browser tasks, use the `--slim` mode:
```json
{
"mcpServers": {
"chrome-devtools": {
"command": "npx",
"args": ["-y", "chrome-devtools-mcp@latest", "--slim", "--headless"]
}
}
}
```
See [Slim tool reference][slim-tool-reference].
### MCP Client configuration
For setup instructions specific to your editor or agent (e.g. Antigravity, Claude Code, Cursor, VS Code), please see our [Client Configurations Guide][client-configurations-guide].
@@ -115,6 +100,19 @@ Your MCP client should open the browser and record a performance trace.
> [!NOTE]
> The MCP server will start the browser automatically once the MCP client uses a tool that requires a running browser instance. Connecting to the Chrome DevTools MCP server on its own will not automatically start the browser.
## CLI
The package also includes the `chrome-devtools` CLI. Use it to control the browser from your terminal without MCP:
```sh
npm i chrome-devtools-mcp@latest -g
chrome-devtools navigate_page 1 --url "https://developers.chrome.com"
chrome-devtools take_screenshot 1 --filePath screenshot.png
chrome-devtools stop
```
See the [CLI guide][cli] for all commands and options.
## Tools
If you run into any issues, checkout our [troubleshooting guide][troubleshooting].
@@ -124,6 +122,8 @@ See the full [Tool Reference][tool-reference] for a complete list of all support
Find the complete list of server parameters (e.g., `--headless`, `--isolated`, `--slim`) and how to configure WebSocket connections in the [Configuration Guide][configuration-guide].
For basic browser tasks only, the `--slim` flag exposes a reduced set of tools. See the [Slim tool reference][slim-tool-reference].
## Advanced Usage
For advanced features such as handling concurrent sessions, persistent user data directories, connecting to a running Chrome instance instead of starting a new one, or debugging on Android, see our [Advanced Usage Guide][advanced-usage-guide].
+1 -1
View File
@@ -1,6 +1,6 @@
# Chrome DevTools CLI
The `chrome-devtools-mcp` package includes an **experimental** CLI interface that allows you to interact with the browser directly from your terminal. This is particularly useful for debugging or when you want an agent to generate scripts that automate browser actions.
The `chrome-devtools-mcp` package includes a CLI interface that allows you to interact with the browser directly from your terminal. This is particularly useful for debugging or when you want an agent to generate scripts that automate browser actions.
## Getting started